Update the "Locking and syncing" page #11647
Conversation
zanieb
force-pushed
the
zb/sync-docs-ii
branch
from
11fc985 to
a12156d
Compare
zanieb
force-pushed
the
zb/sync-docs-ii
branch
from
a12156d to
a37492a
Compare
|
cc @edmorley if you're interested — I'd be curious to hear if this covers what you're looking for. |
|
@charliermarsh I won't get to this before Monday. Feel free to review if you'd like. |
There was a problem hiding this comment.
cc @edmorley if you're interested — I'd be curious to hear if this covers what you're looking for.
Sorry for the delayed reply - never enough hours in the day!
The additions/changes here are excellent - they cover the things I had in mind and more, whilst still remaining clear and concise. Much better than anything I could have worded - thank you! 😄
| To assert the lockfile matches the project metadata, use the `--locked` flag. If the lockfile is not | ||
| up-to-date, an error will be raised instead of updating the lockfile. | ||
| When considering if the lockfile is up-to-date, uv will check if it matches the project metadata. | ||
| For example, if add a dependency to your `pyproject.toml`, the `uv.lock` will be outdated. |
There was a problem hiding this comment.
| For example, if add a dependency to your `pyproject.toml`, the `uv.lock` will be outdated. | |
| For example, if you add a dependency to your `pyproject.toml`, the `uv.lock` will be outdated. |
|
|
||
| You can also check if the lockfile is up-to-date by passing the `--check` flag to `uv lock`: | ||
| uv will not consider lockfiles outdated when new versions of packages are released — the lockfile | ||
| needs to be explicitly updated to |
There was a problem hiding this comment.
(dangling sentence; but presuming due to this being a draft)
|
|
||
| !!! note | ||
|
|
||
| If the project is not define a build system, it will not be installed. |
There was a problem hiding this comment.
| If the project is not define a build system, it will not be installed. | |
| If the project does not define a build system, it will not be installed. |
|
|
||
| ## Exporting the lockfile | ||
|
|
||
| If you need to integrate uv with other tools or workflows, you can export `uv.lock` to |
There was a problem hiding this comment.
(though the existing wording possibly also correct?)
| If you need to integrate uv with other tools or workflows, you can export `uv.lock` to | |
| If you need to integrate uv with other tools or workflows, you can export `uv.lock` to the |
I need to self-review this still.
Updates the "Locking and syncing" page to actually have content on syncing — which was the original intent, the rest of this file was just copied out of the "Projects" page when I split it into multiple pages.