Skip to content

docs: add pyproject section in examples#10753

Open
radoering wants to merge 1 commit intopython-poetry:mainfrom
radoering:docs-pyproject-section-in-examples
Open

docs: add pyproject section in examples#10753
radoering wants to merge 1 commit intopython-poetry:mainfrom
radoering:docs-pyproject-section-in-examples

Conversation

@radoering
Copy link
Member

@radoering radoering commented Mar 2, 2026

Pull Request Check List

  • Added tests for changed code.
  • Updated documentation for changed code.

I received feedback that it is difficult to see which section an attribute belongs to unless you have just navigated there by clicking on a link on the left-hand side and still remember. Since we have already included the section in some examples, let's do it consistently for all of them.

Summary by Sourcery

Clarify pyproject.toml documentation examples by consistently including their corresponding configuration sections.

Documentation:

  • Add explicit [project] and [tool.poetry] headers (with ellipsis placeholders where needed) to pyproject.toml example snippets to show which section each key belongs to.
  • Correct phrasing from "An URL" to "A URL" in deprecated homepage, repository, and documentation option descriptions.

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 2, 2026

Reviewer's Guide

Standardizes TOML snippets in the pyproject configuration docs by explicitly including their corresponding [project] or [tool.poetry] section headers, and fixes minor wording in URL-related descriptions.

File-Level Changes

Change Details Files
Clarify section context in pyproject TOML examples by adding explicit table headers.
  • Prefixed project-related snippets with a [project] table header, using '# ...' where needed to indicate omitted keys.
  • Prefixed Poetry tool configuration snippets with a [tool.poetry] table header, using '# ...' where needed to indicate omitted keys.
  • Ensured consistency of section headers across all documented keys for both PEP 621 project metadata and [tool.poetry] configuration.
docs/pyproject.md
Improve wording consistency in URL field descriptions.
  • Changed 'An URL' to 'A URL' in homepage, repository, and documentation field descriptions while keeping deprecation notes for project.urls intact.
docs/pyproject.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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@radoering radoering added the impact/docs Contains or requires documentation changes label Mar 2, 2026
@github-actions
Copy link

github-actions bot commented Mar 2, 2026

Deploy preview for website ready!

✅ Preview
https://website-i2934sw3i-python-poetry.vercel.app

Built with commit 6117ad2.
This pull request is being automatically deployed with vercel-action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

impact/docs Contains or requires documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant