poetry icon indicating copy to clipboard operation
poetry copied to clipboard

docs: add docs about `include-groups`

Open finswimmer opened this issue 1 year ago • 2 comments

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-groups option to include dependencies from other groups.

Documentation:

  • Document how to include dependencies from one group in another using the include-groups option in the pyproject.toml file.

finswimmer avatar Feb 10 '25 20:02 finswimmer

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
  • Added a new subsection header and explanatory text for including dependencies across groups
  • Provided a TOML snippet demonstrating test, lint, and dev groups with include-groups
  • Clarified that the dev group aggregates dependencies from specified groups
docs/managing-dependencies.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on 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 issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment @sourcery-ai summary on the pull request to (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on 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 dismiss on 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 review to 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.

sourcery-ai[bot] avatar Feb 10 '25 20:02 sourcery-ai[bot]

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

github-actions[bot] avatar Feb 10 '25 20:02 github-actions[bot]

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.

github-actions[bot] avatar Jul 30 '25 00:07 github-actions[bot]