Improve the uv sync CLI documentation
#5930
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zanieb
added
documentation
charliermarsh
approved these changes
Aug 9, 2024
| /// created. | ||
| /// | ||
| /// The project is re-locked before syncing unless the `--locked` or | ||
| /// `--frozen` flag is provided. |
There was a problem hiding this comment.
Only one can be provided, idk e.g. it shortens to "unless the --locked flag is provided". Could go either way, don't know what is "correct".
| /// | ||
| /// Only applies to `pyproject.toml`, `setup.py`, and `setup.cfg` sources. | ||
| /// May be provided more than once. |
There was a problem hiding this comment.
I feel like this got removed from some other commands in previous PRs?
There was a problem hiding this comment.
I've usually moved it out of the first line but retained it in general. I can audit again at the end.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.