Improve example in README.md#10731
Merged
radoering merged 4 commits intopython-poetry:mainfrom Feb 14, 2026
Merged
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the README’s pyproject.toml example to reflect modern Poetry/PEP 517 metadata, adding an explicit build-system section and adjusting license-related fields to match current Poetry documentation. Flow diagram for updated pyproject_toml structure in README exampleflowchart TB
A[pyproject_toml] --> B[build_system]
B --> B1[requires
poetry_core>=1.0.0]
B --> B2[build_backend
poetry.core.masonry.api]
A --> C[project]
C --> C1[name
my-package]
C --> C2[version
0.1.0]
C --> C3[description]
C --> C4[readme
README.md]
C --> C5[license
MIT]
C --> C6["license_files
[LICENSE]"]
C --> C7[requires_python
>=3.9]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `README.md:32` </location>
<code_context>
+license = "MIT"
+license-files = ["LICENSE"]
+
# No python upper bound for package metadata
requires-python = ">=3.9"
</code_context>
<issue_to_address>
**nitpick (typo):** Consider capitalizing "Python" in this comment.
Change `python` to `Python` in the comment for consistency with the rest of the documentation.
```suggestion
# No Python upper bound for package metadata
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
radoering
reviewed
Feb 14, 2026
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
7f68ce7 to
ca44381
Compare
radoering
approved these changes
Feb 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the example in the main README.md page:
build-systemto the top. This was missing before, but is increasingly important to specify with modern Python ecosystems.licenseand addlicense-files, as documented hereSummary by Sourcery
Update the README’s pyproject.toml example to reflect current recommended Poetry configuration.
Documentation: