Repository navigation
Doc: Fix typos in documentation and docstring - #160743
Merged
Merged
Conversation
methane
requested review from
a team,
AA-Turner,
StanFromIreland,
ZeroIntensity and
pganssle
as code owners
October 27, 2026 04:53
methane
added
skip news
needs backport to 3.14
Documentation build overview
11 files changed ·
|
methane
commented
Oct 27, 2026
| :meth:`!importlib.machinery.FrozenLoader.module_repr`, and | ||
| :meth:`!importlib.machinery.BuiltinLoader.module_repr` are deprecated and | ||
| :meth:`!importlib.machinery.FrozenImporter.module_repr`, and | ||
| :meth:`!importlib.machinery.BuiltinImporter.module_repr` are deprecated and |
There was a problem hiding this comment.
🟢 Approval recommended
The changes are limited to documentation and docstring corrections, with no unresolved issues or runtime changes.
No open issues 🎉
What changed in this PR
This PR corrects typos and inaccurate API names in CPython documentation and an email policy docstring. It does not change runtime behavior.
Changes:
- Corrects parameter names, MIME terminology, and historical API references.
- Fixes C API identifiers and datetime macro markup.
- Corrects an MRO example and release-note wording.
| File | Description |
|---|---|
| Misc/NEWS.d/3.15.0a1.rst | Corrects the function watcher event name and grammar. |
| Lib/email/policy.py | Corrects the docstring’s refold_source setting name. |
| Doc/whatsnew/3.11.rst | Corrects importer class names. |
| Doc/whatsnew/3.10.rst | Corrects zipimport, importer, and Thread references. |
| Doc/library/select.rst | Corrects the fflags parameter name. |
| Doc/library/mailbox.rst | Corrects the set_info example argument. |
| Doc/library/email.policy.rst | Corrects the refold_source setting name. |
| Doc/library/email.message.rst | Corrects the multipart/alternative MIME type. |
| Doc/library/email.generator.rst | Corrects parameter names and an email header name. |
| Doc/howto/mro.rst | Replaces zero with class O in a linearization example. |
| Doc/c-api/function.rst | Corrects the function watcher event identifier. |
| Doc/c-api/datetime.rst | Corrects datetime import macro markup. |
Review effort: Balanced
StanFromIreland
approved these changes
Oct 27, 2026
|
Thanks @methane for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15. |
|
Sorry, @methane, I could not cleanly backport this to Please backport manually with cherry_picker, see the devguide for more information. |
|
GH-160794 is a backport of this pull request to the 3.15 branch. |
|
GH-160795 is a backport of this pull request to the 3.14 branch. |
methane
added a commit
that referenced
this pull request
Oct 28, 2026
(cherry picked from commit dbf9776) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
methane
added a commit
that referenced
this pull request
Oct 28, 2026
(cherry picked from commit dbf9776)
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.
No description provided.