python-poetry / python-poetry/poetry
Document `platform` and `python` shorthands for long-form dependencies
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 34.3k
- Forks
- 2.5k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 30
Description
Issue Kind
Improving documentation
Existing Link
https://python-poetry.org/docs/dependency-specification/#using-environment-markers
Description
The marker documentation in the dependency spec does not currently document the python and platform short-hands. We should document them, and make clear whether or not they should be used (or are deprecated); the combining semantics with markers also needs to be made clear.
We should also explain why they exist, whether or not future short-hand forms are likely, and provide more examples showcasing how to use the markers field for end users.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the environment-markers section at the linked dependency-specification documentation. Review how the python and platform shorthands currently behave and how they combine with the markers field, then document their status, purpose, future shorthand expectations, and representative end-user examples. Done means the marker documentation answers these questions without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100