Repository navigation
Conversation
methane
requested review from
gaogaotiantian,
gpshead and
pablogsal
as code owners
November 5, 2026 08:04
methane
requested review from
1st1,
cmaloney,
giampaolo and
picnixz
as code owners
November 5, 2026 08:04
methane
requested review from
AA-Turner,
JelleZijlstra,
ZeroIntensity,
asvetlov,
ericsnowcurrently,
kumaraditya303,
savannahostrowski and
willingc
as code owners
November 5, 2026 08:04
Documentation build overview
61 files changed ·
|
There was a problem hiding this comment.
🟡 Changes recommended
The revised tracemalloc example omits most_recent_first=True, causing its traceback order to contradict the heading and displayed output.
1 open issue
What changed in this PR
This documentation-only PR corrects examples, API names, cross-references, and terminology across CPython’s library reference, extension guides, and release notes.
Changes:
- Fix syntax, arguments, and displayed output in documentation examples.
- Correct API references, parameter names, and technical descriptions.
- Repair historical release-note errors and minor prose mistakes.
| File | Description |
|---|---|
| Doc/whatsnew/3.9.rst | Correct lock examples and grammar. |
| Doc/whatsnew/3.8.rst | Fix Py_INCREF syntax. |
| Doc/whatsnew/3.7.rst | Correct PEP link and islice argument name. |
| Doc/whatsnew/3.6.rst | Correct removed trace API names. |
| Doc/whatsnew/3.4.rst | Fix importlib helper and module-spec references. |
| Doc/whatsnew/3.15.rst | Correct finite-field terminology. |
| Doc/whatsnew/3.12.rst | Correct PEP number and unittest examples. |
| Doc/whatsnew/3.11.rst | Correct deprecated importlib function names. |
| Doc/whatsnew/3.1.rst | Fix SQL GROUP BY syntax. |
| Doc/whatsnew/2.7.rst | Fix capsule example parentheses. |
| Doc/whatsnew/2.5.rst | Correct dictionary comment and header filename. |
| Doc/whatsnew/2.4.rst | Fix email attribute and logging format. |
| Doc/whatsnew/2.3.rst | Correct POSIX function name and interactive prompt. |
| Doc/library/xml.dom.rst | Identify the correct query-method class. |
| Doc/library/tracemalloc.rst | Format traceback lines in the example. |
| Doc/library/timeit.rst | Correct target-time parameter reference. |
| Doc/library/threading.rst | Point reentrant-lock references to RLock.release. |
| Doc/library/tarfile.rst | Correct class and archive-opening references. |
| Doc/library/ssl.rst | Correct example hostname and buffer I/O methods. |
| Doc/library/profiling.sampling.rst | Fix generated filename example. |
| Doc/library/profile.rst | Correct timer-unit descriptions. |
| Doc/library/pdb.rst | Correct post-mortem function reference. |
| Doc/library/os.rst | Correct timestamp and signal parameter names. |
| Doc/library/optparse.rst | Correct values-class names and method markup. |
| Doc/library/multiprocessing.rst | Reference temporary-directory creation correctly. |
| Doc/library/logging.rst | Correct date-formatting function terminology. |
| Doc/library/io.rst | Pass encoding by keyword in the example. |
| Doc/library/http.cookies.rst | Correct the __Host- cookie prefix. |
| Doc/library/http.client.rst | Fix displayed response output. |
| Doc/library/ftplib.rst | Correct implicit login arguments. |
| Doc/library/doctest.rst | Attribute runner properties to the correct class. |
| Doc/library/codecs.rst | Correct the Nameprep RFC reference. |
| Doc/library/cgitb.rst | Clarify replacement-package contents. |
| Doc/library/cgi.rst | Clarify replacement-package contents. |
| Doc/library/calendar.rst | Align documented parameter names with methods. |
| Doc/library/binascii.rst | Correct newline-encoding option description. |
| Doc/library/asyncio-eventloop.rst | Align callback timing prose with the example. |
| Doc/library/argparse.rst | Correct help text and parsed output examples. |
| Doc/library/annotationlib.rst | Retrieve annotations from the example class. |
| Doc/howto/logging-cookbook.rst | Correct an IP-address prefix in a comment. |
| Doc/howto/isolating-extensions.rst | Fix C method-table punctuation. |
| Doc/howto/instrumentation.rst | Fix comment terminators in SystemTap examples. |
| Doc/howto/descriptor.rst | Correct a C API name in a comment. |
| Doc/extending/extending.rst | Correct the function named in lifetime guidance. |
| Doc/extending/embedding.rst | Align initialization prose with the example API. |
| Doc/c-api/typeobj.rst | Use the correct allocation function in the example. |
| Doc/c-api/module.rst | Fix C declarations and statement terminators. |
Review effort: Balanced
Member
|
This is a big PR! Might be easier to get it merged by splitting it into one per top-level directory. |
StanFromIreland
left a comment
StanFromIreland
left a comment
Member
There was a problem hiding this comment.
I've looked through, two little comments, but otherwise seems like a nice improvement. The PR is quite sizeable, but many fixes are trivial.
Co-authored-by: Stan Ulbrych <stan@python.org>
StanFromIreland
approved these changes
Nov 5, 2026
Member
Author
|
@hugovk For this PR, please feel free to review only the files you're interested in. If there are any files you'd prefer to review later when you have more time, just let me know. I'll remove them from this PR and submit them in a separate PR. |
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.