python / python/docs-community
Changing docs for trivial issues
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 55
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
There's this open issue right now on British vs American spelling:
https://github.com/python/cpython/issues/82221
In the past, there's been some merged PRs on similar smallish consistency/grammar issues:
https://github.com/python/cpython/pull/2787
https://github.com/python/cpython/pull/25985
However, there are also these other comments that seem to resist against trivial changes:
https://github.com/python/cpython/issues/58372#issuecomment-1093572060
https://github.com/python/cpython/issues/62480#issuecomment-1093619748
The sense that I'm getting is that trivial / minor grammatical / consistency issues are generally not considered if it's either unreported, too large such that it'll take more core dev reviewing time than it's worth in improvement, or touches on somewhat historical docs. Would this be an accurate summary on whether to consider committing small changes?
Contributor guide
No contributing guide indexed for this repository
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
Review the linked issue and pull requests about British/American spelling and small grammar or consistency changes, then compare the resisting comments in issues 58372 and 62480. The work is complete when the project’s position on accepting trivial documentation changes is clearly summarized for contributors.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100