Skip to content

Conversation

@zanieb
Copy link
Member

@zanieb zanieb commented Oct 25, 2024

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.

@zanieb zanieb added the documentation Improvements or additions to documentation label Oct 25, 2024
@zanieb zanieb mentioned this pull request Oct 25, 2024
Comment on lines 471 to 485
```toml title="pyproject.toml"
[tool.uv]
dev-dependencies = [
"pytest"
]
```
Copy link
Member

@MichaReiser MichaReiser Oct 25, 2024

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?

Copy link
Member Author

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.

Copy link
Member

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.)

"ruff"
]
```

Copy link

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.)

Copy link
Member Author

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.

@zanieb zanieb merged commit 9141892 into tracking/735 Oct 25, 2024
@zanieb zanieb deleted the zb/735-docs branch October 25, 2024 18:15
zanieb added a commit that referenced this pull request Oct 25, 2024
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`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants