gh-135913: Document ob_refcnt, ob_type, ob_size (GH-135914)
* gh-135913: Document ob_refcnt, ob_type, ob_size
In `typeobj.rst`, instead of `:c:member:` it would be better to
use `.. c:member::` with a `:no-index:` option, see:
See ref. https://www.sphinx-doc.org/en/master/usage/domains/index.html#basic-markup
However, `c:member` currently does not support `:no-index:`.
(cherry picked from commit 73e1207a4e)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
gh-136032: Fix `argparse.BooleanOptionalAction` doc (GH-136133)
(cherry picked from commit 1953713d0d)
Co-authored-by: W. H. Wang <mattwang44@gmail.com>
gh-86682: Add versionadded for sys._getframemodulename (GH-136325)
add versionadded for sys._getframemodulename
(cherry picked from commit 11f074b243)
Co-authored-by: Anthony Sottile <asottile@umich.edu>
* Turn the __future__ table to list-table.
This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
(cherry picked from commit 2468aafe98)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
gh-127502: Remove XML vulnerability table (GH-135294)
* Remove the table
* Replace warnings with notes
Latest releases of Python 3.9-3.15 include expat 2.7.1 which is not vulnerable.
expat 2.6.0 was released in February 2024.
(cherry picked from commit cb99d99277)
Co-authored-by: Victor Stinner <vstinner@python.org>
gh-109070: Document that get_context in multiprocessing have side effect (GH-136341)
Document that get_context in multiprocessing have side effect
(cherry picked from commit 77a8bd29da)
Co-authored-by: AN Long <aisk@users.noreply.github.com>
gh-135252: Document Zstandard integration across zipfile, shutil, and tarfile (GH-135311)
Document Zstandard integration across zipfile, shutil, and tarfile
(cherry picked from commit 938a5d7e62)
Co-authored-by: Emma Smith <emma@emmatyping.dev>
Replace `capi-sig` mailing list with `discuss.python.org` (GH-136211)
(cherry picked from commit 7afe1adb00)
Co-authored-by: sobolevn <mail@sobolevn.me>
gh-136169: Update parameter name in fractions.from_float method (GH-136172)
Update parameter name in fractions.from_float method
(cherry picked from commit 9c0cb5beb8)
Co-authored-by: Vladyslav Lazoryk <80263725+lazorikv@users.noreply.github.com>
* gh-127604: Docs: Include a C stack in the `faulthandler` example (GH-136081)
(cherry picked from commit 3947847914)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
The iOS testbed now treats the app_packages folder as a site folder. This ensures it is
on the path, but also ensures any .pth files are processed on app startup.
(cherry picked from commit b38810bab7)
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
gh-135110: Fix misleading `generator.close()` documentation (GH-135152)
The documentation incorrectly stated that generator.close() 'raises' a
GeneratorExit exception. This was misleading because the method doesn't
raise the exception to the caller - it sends the exception internally
to the generator and returns None.
(cherry picked from commit 0d76dccc3b)
Co-authored-by: Connor Denihan <188690869+cdenihan@users.noreply.github.com>
gh-135965: Delete duplicate word in isolating-extensions howto (GH-135964)
Change use use to use.
(cherry picked from commit ffb2a02f98)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
Names/macros defined in public headers should have `Py`/`_Py` prefixes.
(cherry picked from commit a1da208eec)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Add whatsnew text for warnings module changes. (gh-135869)
(cherry picked from commit 1f5e23fd70)
Co-authored-by: Neil Schemenauer <nas-github@arctrix.com>
Docs: Fix indentation in `slice` class of `functions.rst` (GH-134393)
Paragraph should not be under `slice.step`. It applies to the whole class.
(cherry picked from commit 6227662ff3)
Co-authored-by: Rob Reynolds <13379223+reynoldsnlp@users.noreply.github.com>
Docs: Add cross-reference for `positional_item` in the `calls` productionlist (GH-129977)
Add missing hyperlink for `positional_item`
(cherry picked from commit d2154912b3)
Co-authored-by: HarryLHW <123lhw321@gmail.com>
gh-135805: Document the X option and env var for controlling thread-local bytecode (GH-135868)
Document the X option and env var for controlling thread-local bytecode.
(cherry picked from commit fea5ccc55d)
Co-authored-by: mpage <mpage@meta.com>
Adds a note about flush/close on copyfileobj, and updates
the Emscripten build script to follow documented advice.
(cherry picked from commit 34393cbdd4)
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
Fix example according to PEP 750 in "What's new in 3.14" (GH-134727)
A redundant extra part was written. Added a closing tag, to match the usage in PEP 750.
(cherry picked from commit 2793b68f75)
Co-authored-by: Vincent Poulailleau <vpoulailleau@gmail.com>
Docs: Use `arguments` to replace `args` in `argparse.rst` (GH-135510)
(cherry picked from commit caad163b69)
Co-authored-by: Yongzi Li <204532581+Yzi-Li@users.noreply.github.com>
Docs: Document `PyExceptionClass` functions in the C API (GH-135697)
* Docs: Document `PyExceptionClass_Name`
`PyExceptionClass_Name` is an undocumented function in the limited API.
* Document `PyExceptionClass_Check`
(cherry picked from commit 59963e866a)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>