docs: explain dependency marker shorthands - #11126
Closed
Mohamedajab wants to merge 2 commits into
Closed
Mohamedajab wants to merge 2 commits into
Mohamedajab wants to merge 2 commits into
Conversation
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 path="docs/dependency-specification.md" line_range="610" />
<code_context>
+
+This installs `example` only when all three restrictions match. The shorthand
+properties are specific to `[tool.poetry.dependencies]`; dependencies in
+`[project.dependencies]` use standard PEP 508 marker expressions instead.
+
### `extra` environment marker
</code_context>
<issue_to_address>
**nitpick:** The documentation refers to `[project.dependencies]` as a dependency section, but PEP 621 dependencies are declared as the `dependencies` key inside the `[project]` table; `[project.dependencies]` is not a valid section for this syntax. Readers who follow this wording can create an invalid or ignored configuration.
**Suggested fix:** Replace `[project.dependencies]` with `[project]` and clarify that its `dependencies` array uses PEP 508 marker expressions.
</issue_to_address>Sourcery assessment
Approved.
Contributor
|
Explain why not #10952 |
Contributor
Author
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.
Resolves: #9183
Documents the Poetry-specific
pythonandplatformdependency shorthands, explains when to usemarkers, and clarifies that restrictions supplied through multiple properties are combined withand. It also distinguishes[tool.poetry.dependencies]shorthand syntax from standard PEP 508 markers in[project.dependencies].Validation: all configured pre-commit hooks passed for
docs/dependency-specification.md.