-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Add documentation for PEP 735 support #8566
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
70976ea to
9c24725
Compare
9c24725 to
efecf29
Compare
| ```toml title="pyproject.toml" | ||
| [tool.uv] | ||
| dev-dependencies = [ | ||
| "pytest" | ||
| ] | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really relevant for the documentation but what happens if I run uv add --dev xx when there's only a dev-dependency but no dev dependency group?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a great question, Charlie is fixing the behavior there (right now we actually never add to the dev group during uv add --dev) so I'm not sure what the final behavior is yet. I'll update this to include that once he puts up that PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(It adds to dev-dependencies.)
efecf29 to
a6b83fa
Compare
| "ruff" | ||
| ] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be useful somewhere in here to state explicitly that uv add --dev is equivalent to uv add -- group dev, etc. (Unless they aren't entirely equivalent, e.g. maybe something with the handling of uv.tool.dev-dependencies as in Micha's comment below, in which case that should be clarified.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do!
#8567 also adds some context in the CLI about the equivalence of these commands.
This adds the minimal documentation I think we need to release PEP 735 support. I want to add documentation on `include-group` and such but that can come after. I also want to restructure some of the project dependency documentation, but that will be easier once this all lands in `main`.
This adds the minimal documentation I think we need to release PEP 735 support.
I want to add documentation on
include-groupand such but that can come after.I also want to restructure some of the project dependency documentation, but that will be easier once this all lands in
main.