Open
Conversation
Add guidance on keeping typo-fix PRs small and focused, listing appropriate directories (Doc/, Misc/, Misc/NEWS.d/) and noting that large sweeping PRs may be closed.
- Clarify which directories are appropriate for typo fixes - Encourage small, focused PRs to reduce reviewer notification burden - Explicitly note that large PRs or PRs outside listed directories may be closed with a reference to this section
Documentation build overview
78 files changed ·
|
willingc
reviewed
Apr 16, 2026
Collaborator
willingc
left a comment
willingc
left a comment
There was a problem hiding this comment.
Thanks @johnslavik. Please leave a brief note in the PR submission message what prompted you to propose these devguide changes. I do think that this is a useful addition. ☀️
| #. **Keep your pull request focused and small.** A pull request should address | ||
| one issue or add one feature. Combining multiple unrelated changes makes a | ||
| pull request harder to review and increases the number of people notified | ||
| unnecessarily. When in doubt, split into separate pull requests. |
Collaborator
There was a problem hiding this comment.
Suggested change
| unnecessarily. When in doubt, split into separate pull requests. | |
| unnecessarily. |
| Typo fixes | ||
| ========== | ||
|
|
||
| Fixing typos and grammatical errors in documentation is a welcome |
Collaborator
There was a problem hiding this comment.
Suggested change
| Fixing typos and grammatical errors in documentation is a welcome | |
| Fixing typos and grammatical errors in documentation is a |
Comment on lines
+275
to
+285
| places for such fixes are: | ||
|
|
||
| * The ``Doc/`` directory (end-user documentation) | ||
| * Internal documentation, such as files in ``Misc/`` | ||
| * News entries under ``Misc/NEWS.d/`` | ||
|
|
||
| Keep typo-fix PRs **small and focused**, ideally limited to one file or a | ||
| small set of closely related files. Large PRs that touch many unrelated files | ||
| notify a large number of reviewers unnecessarily and are harder to review. | ||
| Large typo-fix PRs, or PRs touching directories outside those listed above, | ||
| may be closed with a reference to this section. |
Collaborator
There was a problem hiding this comment.
Suggested change
| places for such fixes are: | |
| * The ``Doc/`` directory (end-user documentation) | |
| * Internal documentation, such as files in ``Misc/`` | |
| * News entries under ``Misc/NEWS.d/`` | |
| Keep typo-fix PRs **small and focused**, ideally limited to one file or a | |
| small set of closely related files. Large PRs that touch many unrelated files | |
| notify a large number of reviewers unnecessarily and are harder to review. | |
| Large typo-fix PRs, or PRs touching directories outside those listed above, | |
| may be closed with a reference to this section. | |
| place for such fixes is the ``Doc/`` directory (end-user documentation). | |
| Keep typo-fix PRs **small and focused**. Large PRs that touch many unrelated files | |
| notify a large number of reviewers unnecessarily and are harder to review. | |
| Large typo-fix PRs, or PRs touching directories outside those listed above, | |
| may be closed with a reference to this section. |
Member
There was a problem hiding this comment.
IMO we can also include InternalDocs.
Collaborator
There was a problem hiding this comment.
I was on the fence about InternalDocs. No objection about keeping it in.
Comment on lines
+275
to
+285
| places for such fixes are: | ||
|
|
||
| * The ``Doc/`` directory (end-user documentation) | ||
| * Internal documentation, such as files in ``Misc/`` | ||
| * News entries under ``Misc/NEWS.d/`` | ||
|
|
||
| Keep typo-fix PRs **small and focused**, ideally limited to one file or a | ||
| small set of closely related files. Large PRs that touch many unrelated files | ||
| notify a large number of reviewers unnecessarily and are harder to review. | ||
| Large typo-fix PRs, or PRs touching directories outside those listed above, | ||
| may be closed with a reference to this section. |
Member
There was a problem hiding this comment.
IMO we can also include InternalDocs.
| <https://github.com/python/cpython/issues/126133#issuecomment-2460824052>`__. | ||
|
|
||
|
|
||
| .. _typo-fixes: |
Member
There was a problem hiding this comment.
Did you mean to reference the section somewhere?
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
3 participants
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.
Closes #1448