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: the python version is not mandatory in the dependencies section #10104

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

felixgwilliams
Copy link

@felixgwilliams felixgwilliams commented Jan 24, 2025

The docs say that the python version must be declared in the tool.poetry.dependencies section

Be aware that declaring the python version for which your package is compatible is mandatory:

This is no longer true, as the version can be declared in project.requires-python only.
I just removed the note saying it is mandatory.

Pull Request Check List

Resolves: #10103

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

Summary by Sourcery

Documentation:

  • Remove the note stating that declaring the Python version in tool.poetry.dependencies is mandatory.

Copy link

sourcery-ai bot commented Jan 24, 2025

Reviewer's Guide by Sourcery

This pull request removes the note in the documentation that states that the python version must be declared in the tool.poetry.dependencies section. This is because the version can be declared in project.requires-python only.

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

File-Level Changes

Change Details Files
Removed the note about the python version being mandatory in the dependencies section.
  • Removed the note stating that declaring the python version in the tool.poetry.dependencies section is mandatory.
docs/pyproject.md

Possibly linked issues


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

Overall Comments:

  • Consider adding a brief note mentioning that Python version requirements can be specified in project.requires-python to help guide users to the correct location.
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.

docs/pyproject.md Show resolved Hide resolved
@felixgwilliams
Copy link
Author

I just added some more words about how the python version specifications interact. I think what I wrote is correct but let me know if it's not or if it's too long

@felixgwilliams felixgwilliams requested a review from abn January 25, 2025 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify whether the python version needs to be specified in [tool.poetry.dependencies]
4 participants