docs: add docs about `include-groups`
Pull Request Check List
Requires: https://github.com/python-poetry/poetry-core/pull/837 Resolves: https://github.com/python-poetry/poetry/issues/7494
Summary by Sourcery
Add documentation for the include-groups option, which allows including dependencies from one group in another.
New Features:
- Introduce the
include-groupsoption to include dependencies from other groups.
Documentation:
- Document how to include dependencies from one group in another using the
include-groupsoption in thepyproject.tomlfile.
Reviewer's Guide
This PR enhances project documentation by introducing a new “Including dependencies from other groups” section in managing-dependencies.md, detailing the include-groups option and illustrating its usage with a TOML example.
Class diagram for dependency group structure with include-groups
classDiagram
class DependencyGroup {
+name: str
+dependencies: list
+include_groups: list
}
class PoetryProject {
+groups: dict
}
PoetryProject "1" -- "*" DependencyGroup : contains
DependencyGroup <|-- TestGroup
DependencyGroup <|-- LintGroup
DependencyGroup <|-- DevGroup
DevGroup : +include_groups = ["test", "lint"]
TestGroup : +dependencies = ["pytest"]
LintGroup : +dependencies = ["ruff"]
DevGroup : +dependencies = ["tox"]
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Introduce documentation for the include-groups option |
|
docs/managing-dependencies.md |
Tips and commands
Interacting with Sourcery
-
Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
-
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with
@sourcery-ai issueto create an issue from it. -
Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. -
Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. -
Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. -
Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore. -
Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
- Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
Deploy preview for website ready!
✅ Preview https://website-8xmu2pocf-python-poetry.vercel.app
Built with commit e3858cfa7c470775d37775074632fc69135293bf. This pull request is being automatically deployed with vercel-action
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.