-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
base: main
Are you sure you want to change the base?
docs: the python version is not mandatory in the dependencies section #10104
Conversation
…d in the dependencies section
Reviewer's Guide by SourceryThis pull request removes the note in the documentation that states that the python version must be declared in the No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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 |
The docs say that the python version must be declared in the
tool.poetry.dependencies
sectionThis 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
Summary by Sourcery
Documentation:
tool.poetry.dependencies
is mandatory.