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

Fix sections in pyproject.toml docs #9948

Merged

Conversation

kinuax
Copy link
Contributor

@kinuax kinuax commented Jan 5, 2025

Sections for readme and urls in pyproject.toml docs are fixed.

Pull Request Check List

Resolves: none

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

Summary by Sourcery

Documentation:

  • Document the correct sections for readme and urls in pyproject.toml.

Copy link

sourcery-ai bot commented Jan 5, 2025

Reviewer's Guide by Sourcery

This pull request fixes the sections for readme and urls in the pyproject.toml docs by changing the tool.poetry section to project for the urls and removing the tool.poetry prefix for readme.

Class diagram showing updated pyproject.toml configuration structure

classDiagram
    class PyProjectToml {
        +readme: string
    }
    class ProjectUrls {
        +homepage: string
        +repository: string
        +documentation: string
    }
    PyProjectToml -- ProjectUrls
    note for PyProjectToml "readme moved to root level"
    note for ProjectUrls "Changed from tool.poetry.urls to project.urls"
Loading

File-Level Changes

Change Details Files
Updated the urls section to use the correct project table.
  • Changed the urls section from [tool.poetry.urls] to [project.urls].
docs/pyproject.md
Fixed the readme section by removing the tool.poetry prefix.
  • Removed the tool.poetry prefix from the readme 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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 @kinuax - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please check the 'Updated documentation' box in the PR checklist since this is a documentation change.
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 added the impact/docs Contains or requires documentation changes label Jan 6, 2025
Copy link

github-actions bot commented Jan 6, 2025

Deploy preview for website ready!

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

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

@radoering radoering merged commit 07445aa into python-poetry:main Jan 6, 2025
75 checks passed
@kinuax kinuax deleted the fix-sections-in-pyproject-docs branch January 6, 2025 04:48
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