Skip to content
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

docs: fix level of headings in pyproject.md #10263

Merged
merged 3 commits into from
Mar 7, 2025

Conversation

erdnaxeli
Copy link
Contributor

@erdnaxeli erdnaxeli commented Mar 7, 2025

Move requires-poetry into the "The tool.poetry section" section.

Pull Request Check List

Resolves: #issue-number-here

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

Summary by Sourcery

Documentation:

  • Moves the requires-poetry documentation into the tool.poetry section.

Move `requires-poetry` into the "The `tool.poetry` section" section.
Copy link

sourcery-ai bot commented Mar 7, 2025

Reviewer's Guide by Sourcery

This pull request reorganizes the documentation for the requires-poetry setting, moving it to be a subsection under the tool.poetry section in the pyproject.md file. This change improves the structure and clarity of the documentation.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Moved the requires-poetry configuration setting to be a subsection of the tool.poetry section.
  • Changed the heading level of requires-poetry to indicate it's a subsection.
  • Moved the requires-poetry documentation content under the tool.poetry section.
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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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 @erdnaxeli - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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 changed the title Update pyproject.md docs: fix level of headings in pyproject.md Mar 7, 2025
@radoering radoering added the impact/docs Contains or requires documentation changes label Mar 7, 2025
Copy link

github-actions bot commented Mar 7, 2025

Deploy preview for website ready!

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

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

@radoering radoering merged commit c4ec1b0 into python-poetry:main Mar 7, 2025
56 checks passed
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.

2 participants