Commit graph

29267 commits

Author SHA1 Message Date
Miss Islington (bot)
0facabc2d8
[3.13] gh-141343: Fix swapped words in sorted doc (GH-141356)
(cherry picked from commit 59b793b0dd)

Co-authored-by: Yongzi Li <204532581+Yzi-Li@users.noreply.github.com>
2025-11-10 15:02:45 +00:00
Petr Viktorin
6384c7917d
[3.13] Clarify argument/result ownership/validity for PyModule_* functions (GH-141159) (GH-141191)
(cherry picked from commit ffd64737d0)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-10 15:06:58 +01:00
Miss Islington (bot)
cab85ced49
[3.13] gh-140500: Update download.html instructions (GH-141320) (#141346)
Co-authored-by: Karina Souza <97332018+KarinaS0uza@users.noreply.github.com>
Co-authored-by: Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
2025-11-10 12:46:06 +00:00
Miss Islington (bot)
9cbbb2eb21
[3.13] gh-141004: Document pyctype.h macros (GH-141272) (GH-141339)
gh-141004: Document `pyctype.h` macros (GH-141272)
(cherry picked from commit df19261621)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 10:11:39 +00:00
Miss Islington (bot)
70bcf946f1
[3.13] gh-141004: Document Py_DTSF_* macros (GH-141310) (GH-141330)
gh-141004: Document `Py_DTSF_*` macros (GH-141310)
(cherry picked from commit 9b0179fa87)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 00:49:30 +00:00
Miss Islington (bot)
379d8146d0
[3.13] gh-62480: De-personalize "Partial mocking" section in unittest.mock examples (GH-141321) (#141327)
gh-62480: De-personalize "Partial mocking" section in `unittest.mock` examples (GH-141321)

* Refine some wording in unittest partial mock doc

Some of the descriptions were addressed in first person,
but have now been changed to address the user reading the documentation instead.
(cherry picked from commit b618731781)

Co-authored-by: KarnbirKhera <166065758+KarnbirKhera@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2025-11-09 18:08:09 -06:00
Miss Islington (bot)
b9d4cefe76
[3.13] gh-62480: De-personalize "Mocking Unbound Methods" section in unittest.mock examples (GH-141322) (#141325)
gh-62480: De-personalize "Mocking Unbound Methods" section in `unittest.mock` examples (GH-141322)

* Rewrite Mocking Unbound Methods paragraph to second person
(cherry picked from commit ec85d3cbfe)

Co-authored-by: Elena O <31424287+oklena@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-09 18:07:25 -06:00
Miss Islington (bot)
5ad2842915
[3.13] gh-141004: Document PySuper_Type (GH-141315) (GH-141319)
gh-141004: Document `PySuper_Type` (GH-141315)
(cherry picked from commit 14c62227f9)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-09 20:01:33 +00:00
Miss Islington (bot)
811fd8f4a4
[3.13] gh-141004: Document PyClassMethod* and PyStaticMethod* APIs (GH-141296) (GH-141309)
gh-141004: Document `PyClassMethod*` and `PyStaticMethod*` APIs (GH-141296)
(cherry picked from commit 807db68ddd)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-09 18:09:43 +00:00
Miss Islington (bot)
aa2c8ea1e7
[3.13] gh-141004: Document PyFunction_SetKwDefaults (GH-141294) (GH-141305)
gh-141004: Document `PyFunction_SetKwDefaults` (GH-141294)
(cherry picked from commit 18529b580b)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-09 17:55:02 +00:00
Miss Islington (bot)
a9619899fc
[3.13] gh-141004: Document PyExceptionInstance* APIs (GH-141301) (GH-141303)
gh-141004: Document `PyExceptionInstance*` APIs (GH-141301)
(cherry picked from commit b5a0c72492)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-09 12:20:18 -05:00
Miss Islington (bot)
92ae15802d
[3.13] gh-141004: Document Py_func_type_input (GH-141273) (GH-141299)
gh-141004: Document `Py_func_type_input` (GH-141273)
(cherry picked from commit 8dd8498286)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-09 16:28:26 +00:00
Miss Islington (bot)
2dd8812850
[3.13] gh-141004: document curses C API (GH-141254) (#141293)
gh-141004: document `curses` C API (GH-141254)
(cherry picked from commit dbe40904a7)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-09 15:50:46 +00:00
Miss Islington (bot)
a6d980472d
[3.13] gh-141004: Document PyWeakref_CheckRefExact (GH-141279) (GH-141291)
gh-141004: Document `PyWeakref_CheckRefExact` (GH-141279)
(cherry picked from commit 60155329a0)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-09 15:39:53 +00:00
Peter Bierma
7b3f7ffb47
[3.13] gh-141004: Document deprecated aliases for memory allocation (GH-141146) (GH-141289)
* gh-141004: Document deprecated aliases for memory allocation (GH-141146)

(cherry picked from commit 1d738dea63)
2025-11-09 15:37:13 +00:00
Miss Islington (bot)
052a53982a
[3.13] gh-141127: Clarify os.symlink() documentation for argument order (GH-141144) (#141277)
gh-141127: Clarify os.symlink() documentation for argument order (GH-141144)
(cherry picked from commit 7ae440f262)

Co-authored-by: Chilla Kalyan <127284726+chillakalyan@users.noreply.github.com>
2025-11-09 11:19:35 +01:00
Miss Islington (bot)
1cd0b74350
[3.13] gh-141004: Document Py_BUILD_ASSERT* macros (GH-141266) (GH-141270)
gh-141004: Document `Py_BUILD_ASSERT*` macros (GH-141266)
(cherry picked from commit 0ac890bea7)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 19:28:32 +00:00
Miss Islington (bot)
2a300e3642
[3.13] gh-141004: Document the PyDoc_VAR macro (GH-141263) (GH-141265)
gh-141004: Document the `PyDoc_VAR` macro (GH-141263)
(cherry picked from commit 545299773b)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 18:20:56 +00:00
Miss Islington (bot)
10d44f72e5
[3.13] gh-141004: Document PyBUF_WRITEABLE (GH-141255) (GH-141260)
gh-141004: Document `PyBUF_WRITEABLE` (GH-141255)
(cherry picked from commit 5e5fc0404e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-08 17:37:04 +00:00
Miss Islington (bot)
e46b808978
[3.13] gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText (GH-141250) (GH-141257)
gh-141004: Document `PyErr_ProgramTextObject` and `PyErr_ProgramText` (GH-141250)
(cherry picked from commit be1c72a45d)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 15:53:28 +00:00
Miss Islington (bot)
82a274e700
[3.13] gh-141246: Link to correct Windows docs in time.sleep() doc (GH-141248) (#141252)
gh-141246: Link to correct Windows docs in `time.sleep()` doc (GH-141248)
(cherry picked from commit 6545a4e8f8)

Co-authored-by: 莯凛 <1348292515@qq.com>
2025-11-08 15:03:07 +00:00
Miss Islington (bot)
f8147a0316
[3.13] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) (#141235)
gh-141004: correctly document `Py_HASH_*` and `PyHASH_*` as `hash_info` attributes (GH-141233)
(cherry picked from commit 87942d911b)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-08 12:29:55 +00:00
Miss Islington (bot)
be33104f88
[3.13] gh-140793: Improve documentatation and tests for the ensure_ascii option in the json module (GH-140906) (GH-141228)
* Document that ensure_ascii=True forces escaping not only non-ASCII, but also
  non-printable characters (the only affected ASCII character is U+007F).
* Ensure that the help output for the json module does not exceed 80
  columns (except one long line in an example and generated lines).
* Add more tests.
(cherry picked from commit 7e90bac3cc)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-11-08 10:30:15 +00:00
Miss Islington (bot)
46d96dce63
[3.13] gh-139741: Make dist-pdf docs archive build work for macOS (GH-140837) (#141230)
Co-authored-by: Naitree Zhu <Naitreey@gmail.com>
2025-11-08 10:26:51 +00:00
Miss Islington (bot)
a728f7f89f
[3.13] gh-141004: Document Py_HASH_* macros (GH-141205) (#141224)
* gh-141004: Document `Py_HASH_*` macros (GH-141205)

(cherry picked from commit 3989e12d39)
(cherry picked from commit 8cec3d3a9d)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-08 09:22:02 +00:00
Miss Islington (bot)
0efb799852
[3.13] gh-141004: Document PyTraceBack* APIs (GH-141192) (GH-141211)
gh-141004: Document `PyTraceBack*` APIs (GH-141192)
(cherry picked from commit d13ee0ae18)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-07 18:53:05 +00:00
Miss Islington (bot)
26c2a49857
[3.13] gh-141004: Document PyErr_WarnExplicitFormat (GH-141187) (GH-141203)
gh-141004: Document `PyErr_WarnExplicitFormat` (GH-141187)
(cherry picked from commit 9420795b47)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-07 16:25:58 +00:00
Miss Islington (bot)
09cc93dc67
[3.13] gh-141004: Document PyCapsule_Type (GH-141079) (GH-141198)
gh-141004: Document `PyCapsule_Type` (GH-141079)
(cherry picked from commit 7af9b5354d)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-07 14:16:14 +00:00
Rodrigo Girão Serrão
e753887bd2
[3.13] Minor documentation improvements (GH-140626) (#141161) 2025-11-06 17:37:31 +00:00
Miss Islington (bot)
00032a4245
[3.13] gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit (GH-141151) (GH-141157)
* gh-141004: Document `Py_GetRecursionLimit` and `Py_SetRecursionLimit` (GH-141151)
(cherry picked from commit 0b260305d3)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

---------

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-06 17:00:03 +00:00
Peter Bierma
908695b5c7
[3.13] gh-141004: Document PyLong_FromPid and PyLong_AsPid (GH-141028) (GH-141143)
* gh-141004: Document `PyLong_FromPid` and `PyLong_AsPid` (GH-141028)

Co-authored-by: Victor Stinner <vstinner@python.org>
(cherry picked from commit bcc524f82d)
2025-11-06 14:10:24 +00:00
Miss Islington (bot)
ccbee02436
[3.13] gh-141004: Document Py_hexdigits (GH-141059) (GH-141139)
gh-141004: Document `Py_hexdigits` (GH-141059)
(cherry picked from commit 54110e20e0)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-06 13:56:14 +00:00
Miss Islington (bot)
a8cd8f0441
[3.13] gh-141004: Document built-in iterator types in the C API (GH-141006) (GH-141135)
gh-141004: Document built-in iterator types in the C API (GH-141006)

Adds documentation for each of the following:

- PyEnum_Type
- PyFilter_Type
- PyMap_Type
- PyReversed_Type
- PyZip_Type

In addition, PyRange_Type and PyRange_Check are also documented.
(cherry picked from commit 1697cb5710)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-06 12:35:31 +00:00
Miss Islington (bot)
89cb8aa3ba
[3.13] Minor fixes to idle.rst and regenerate help.html (GH-140037) (#141122)
Minor fixes to `idle.rst` and regenerate `help.html` (GH-140037)
(cherry picked from commit 4e6e208be9)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-06 12:11:50 +00:00
Miss Islington (bot)
a29f5218e5
[3.13] gh-140569: recommend the new REPL in the asyncio REPL docs (GH-140570) (#141116)
gh-140569: recommend the new REPL in the asyncio REPL docs (GH-140570)
(cherry picked from commit 8822166200)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-11-06 05:45:18 +00:00
Miss Islington (bot)
8641c471a7
[3.13] gh-118516: clarify that subprocess are automatically killed if transport gets garbage collected (GH-140997) (#141111)
gh-118516: clarify that subprocess are automatically killed if transport gets garbage collected (GH-140997)
(cherry picked from commit 101c9c0a21)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-11-06 10:35:01 +05:30
Miss Islington (bot)
f671739fdc
[3.13] GH-108009: Add clarification of parser and argument defaults in argparse docs (GH-124154) (#141085)
GH-108009: Add clarification of parser and argument defaults in argparse docs (GH-124154)
(cherry picked from commit 95f6e1275b)

Co-authored-by: Savannah Ostrowski <savannah@python.org>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2025-11-05 22:52:43 +00:00
Miss Islington (bot)
fc059dbe55
[3.13] gh-141004: Document PyDict_GET_SIZE (GH-141078) (GH-141083)
gh-141004: Document `PyDict_GET_SIZE` (GH-141078)
(cherry picked from commit f0ab07f22c)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-05 22:41:16 +00:00
Miss Islington (bot)
d29fe3f32c
[3.13] gh-76007: remove curses.__version__ doc (GH-141052) (#141077)
Co-authored-by: Zenith <me@arielle.codes>
2025-11-05 22:07:32 +00:00
Miss Islington (bot)
4907f37eed
[3.13] gh-141004: Document Py_RETURN_NAN and Py_RETURN_INF (GH-141029) (GH-141075)
gh-141004: Document `Py_RETURN_NAN` and `Py_RETURN_INF` (GH-141029)
(cherry picked from commit 5b02c6e920)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-11-05 22:06:41 +00:00
Miss Islington (bot)
db0900be6e
[3.13] Docs: replace an esoteric Von Neumann mention (GH-137598) (#140371)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2025-11-05 23:40:56 +02:00
Miss Islington (bot)
91b85c5346
[3.13] gh-139313: Improve docs on XML security (GH-139460) (GH-141066)
Clarify that:
- it takes parsing for an attack
- that some doors are closed by default
- only Expat version 2.7.2 has all the fixes
- use of the bundle depends on configuration
(cherry picked from commit baa9f33897)

Co-authored-by: Sebastian Pipping <sebastian@pipping.org>
2025-11-05 19:06:37 +00:00
Miss Islington (bot)
2dd0a6ad9c
[3.13] Docs: Fix cached calls count in factorial example (gh-140882) (gh-141032)
Co-authored-by: Clifford Gama <cliffygamy@gmail.com>
2025-11-05 12:15:05 -06:00
Miss Islington (bot)
7ac9048ce9
[3.13] gh-141004: Document PyMemoryView_Type (GH-141034) (GH-141055)
gh-141004: Document `PyMemoryView_Type` (GH-141034)
(cherry picked from commit 3f6aca1be4)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-05 16:51:31 +00:00
Miss Islington (bot)
a3756c6ea0
[3.13] gh-141004: Document missing iterator types in the C API (GH-141010) (GH-141047)
gh-141004: Document missing iterator types in the C API (GH-141010)

Add documentation for each of the following:

- PyByteArrayIter_Type
- PyBytesIter_Type
- PyListIter_Type
- PyListRevIter_Type
- PySetIter_Type
- PyTupleIter_Type
- PyRangeIter_Type
- PyLongRangeIter_Type
- PyDictIterKey_Type
- PyDictRevIterKey_Type
- PyDictIterValue_Type
- PyDictRevIterValue_Type
- PyDictIterItem_Type
- PyDictRevIterItem_Type

---------
(cherry picked from commit 35528fccdc)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-05 14:22:32 +00:00
Miss Islington (bot)
82ed4d0707
[3.13] gh-141004: Document Py_UNICODE_{HIGH, LOW}_SURROGATE functions (GH-141019) (GH-141026)
gh-141004: Document `Py_UNICODE_{HIGH, LOW}_SURROGATE` functions (GH-141019)
(cherry picked from commit bfe54810c4)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-04 21:24:52 +00:00
Filip Łajszczak
d76e411891
[3.13] gh-139434: Update selected RFC 2822 references to RFC 5322 (GH-139435) (#141024)
Update selected RFC 2822 references to RFC 5322

RFC 2822 was obsoleted by RFC 5322 in 2008. This updates references
to use the current standard in documentation, docstrings, and comments.

It preserves RFC 2822 references in legacy API components to maintain their
historical context.

RFC 822 → RFC 2822 → RFC 5322 progression is explained where relevant.

In some places specific sections of RFC are referenced where it seems helpful.

Scout rule was applied in some places and RFC mentions format was
normalized in doc strings and comments.
(cherry picked from commit ce1bb85d28)
2025-11-04 16:22:31 -05:00
Miss Islington (bot)
426daef412
[3.13] Docs: Fix typo in email.headerregistry.rst (GH-140965) (#141021)
Docs: Fix typo in `email.headerregistry.rst` (GH-140965)

Fix missing 'Header' suffix on header class name in `email.headerregistry.rst`
(cherry picked from commit 97d8dda980)

Co-authored-by: Guo Ci <zguoci@gmail.com>
2025-11-04 19:35:14 +00:00
Miss Islington (bot)
fbfa3e3fe8
[3.13] gh-134817: Restore accidentally deleted line in documentation. (GH-141013) (GH-141017)
(cherry picked from commit 66c86c6)
2025-11-04 18:57:32 +00:00
Miss Islington (bot)
aa4dd4ece8
[3.13] Document that returning sys.monitoring.DISABLE in response to a global event raises ValueError (GH-140726) (GH-141015)
Document that returning `sys.monitoring.DISABLE` in response to a global event raises `ValueError` (GH-140726)
(cherry picked from commit 8a7dbb7a68)

Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-04 18:36:40 +00:00