Commit graph

30049 commits

Author SHA1 Message Date
Sergey B Kirpichev
ed5c854c6a
[3.14] gh-141004: Document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN (GH-141544) (#141698)
(cherry picked from commit 630cd37bfa)

Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-18 14:32:44 +01:00
Serhiy Storchaka
d89eb2f984
[3.14] gh-140873: Fix the singledispatchmethod documentation (GH-141523)
It does not support non-descriptor callables yet.
2025-11-18 13:16:39 +02:00
Miss Islington (bot)
3388413fc5
[3.14] Add missing backticks in os and decimal docs (GH-141699) (#141705)
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2025-11-18 10:37:49 +00:00
Miss Islington (bot)
cf2524f2b7
[3.14] gh-141004: Document Py_MEMCPY (GH-141676) (GH-141685)
gh-141004: Document `Py_MEMCPY` (GH-141676)
(cherry picked from commit 16ea9505ce)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-17 22:57:47 +00:00
Miss Islington (bot)
aa887aa2a8
[3.14] gh-141004: Document PyODict* APIs (GH-141136) (GH-141677)
gh-141004: Document `PyODict*` APIs (GH-141136)
(cherry picked from commit b3626321b6)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-17 19:46:23 +00:00
Miss Islington (bot)
cc315dc6d4
[3.14] gh-130160: Add anchors to CLI Usage section for cmdline (GH-133182) (#141664)
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
2025-11-17 14:57:26 +00:00
Miss Islington (bot)
eeb5fbf5f7
[3.14] gh-141650: Fix typo in xml.sax.saxutils.unescape documentation (GH-141652) (#141654)
Co-authored-by: Tamzin Hadasa Kelly <tk.infinity@gmail.com>
2025-11-17 13:02:03 +00:00
Miss Islington (bot)
c9eb5cb1c0
[3.14] gh-141004: Document missing PyCFunction* and PyCMethod* APIs (GH-141253) (GH-141637)
gh-141004: Document missing `PyCFunction*` and `PyCMethod*` APIs (GH-141253)
(cherry picked from commit be699d6c7c)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-16 19:31:25 +00:00
Miss Islington (bot)
10db8ee968
[3.14] gh-141004: Document the PyPickleBuffer_* C API (GH-141630) (GH-141632)
gh-141004: Document the `PyPickleBuffer_*` C API (GH-141630)
(cherry picked from commit e33afa7ddb)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-16 18:56:41 +00:00
Miss Islington (bot)
2f23c88243
[3.14] gh-139344: Remove pending removal notice for undeprecated importlib.resources API (GH-141507) (GH-141558)
(cherry picked from commit 49e74210cb)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-14 16:32:05 +01:00
Miss Islington (bot)
dbe64ee95f
Add PyManager troubleshooting steps for direct launch of script files (GH-141530)
(cherry picked from commit b101e9d36b)

Co-authored-by: Steve Dower <steve.dower@python.org>
2025-11-14 15:29:39 +00:00
Miss Islington (bot)
72a8ea773b
[3.14] gh-141004: Document PyOS_InterruptOccurred (GH-141526) (GH-141549)
gh-141004: Document `PyOS_InterruptOccurred` (GH-141526)
(cherry picked from commit ef90261be5)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-14 11:26:37 +00:00
Miss Islington (bot)
c5e0ce73f9
[3.14] gh-141004: Document PyErr_RangedSyntaxLocationObject (GH-141521) (#141525)
gh-141004: Document `PyErr_RangedSyntaxLocationObject` (GH-141521)

PyErr_RangedSyntaxLocationObject
(cherry picked from commit 196f1519cd)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-13 18:05:09 +00:00
Miss Islington (bot)
425e423f9f
[3.14] gh-141004: Document PyCode_Optimize (GH-141378) (GH-141514)
gh-141004: Document `PyCode_Optimize` (GH-141378)
(cherry picked from commit d7862e9b1b)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-13 15:15:27 +00:00
Miss Islington (bot)
f43e5955eb
[3.14] gh-141004: Document C APIs for dictionary keys, values, and items (GH-141009) (GH-141512)
gh-141004: Document C APIs for dictionary keys, values, and items (GH-141009)
(cherry picked from commit f72768f30e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-13 15:08:35 +00:00
Miss Islington (bot)
42e0468209
[3.14] gh-141004: Document PyRun_InteractiveOneObject (GH-141405) (GH-141485)
gh-141004: Document `PyRun_InteractiveOneObject` (GH-141405)
(cherry picked from commit 26b7df2430)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-12 22:58:52 +00:00
Miss Islington (bot)
996c00384d
[3.14] gh-141412: Use reliable target URL for urllib example (GH-141474)
The endpoint used for demonstrating reading URLs is no longer
stable. This change substitutes a target over which we have more
control.
(cherry picked from commit fbcac79951)

Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
2025-11-12 18:40:20 +00:00
Miss Islington (bot)
fe3826cbaf
[3.14] gh-141004: Document Py_MATH_{E, PI, TAU} constants (GH-141373) (#141471)
gh-141004: Document `Py_MATH_{E, PI, TAU}` constants (GH-141373)
(cherry picked from commit f1330b35b8)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-12 17:02:38 +00:00
Miss Islington (bot)
24bf09b42c
[3.14] gh-141004: Document PyType_SUPPORTS_WEAKREFS (GH-141408) (GH-141470)
gh-141004: Document `PyType_SUPPORTS_WEAKREFS` (GH-141408)
(cherry picked from commit 9cd5427d96)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-12 16:44:17 +00:00
Miss Islington (bot)
b883ad17cd
[3.14] gh-141370: document undefined behavior of Py_ABS() (GH-141439) (GH-141454)
(cherry picked from commit 20f53df07d)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-11-12 09:56:47 +00:00
Peter Bierma
604a5a6a11
[3.14] gh-141004: Document PyBytes_Repr and PyBytes_DecodeEscape (GH-141407) (GH-141440)
* gh-141004: Document `PyBytes_Repr` and `PyBytes_DecodeEscape` (GH-141407)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
(cherry picked from commit 37e2762ee1)
2025-11-12 02:06:36 +00:00
Miss Islington (bot)
21c9c919aa
[3.14] gh-137952: update csv.Sniffer().has_header() docs to describe the actual off-by-onish behavior (GH-137953) (#141434)
gh-137952: update `csv.Sniffer().has_header()` docs to describe the actual off-by-onish behavior (GH-137953)

* checks 21, not 20
* Say "header" instead of "first row" to disambiguate per review.

---------
(cherry picked from commit 0d7b48a8f5)

Co-authored-by: Maurycy Pawłowski-Wieroński <maurycy@maurycy.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-11 16:13:10 -08:00
Miss Islington (bot)
91f33ef3c8
[3.14] gh-141004: Document PyFile_OpenCode and PyFile_OpenCodeObject (GH-141413) (GH-141425)
gh-141004: Document `PyFile_OpenCode` and `PyFile_OpenCodeObject` (GH-141413)
(cherry picked from commit 2befce86e6)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-11 16:48:29 -05:00
Miss Islington (bot)
03fca07f83
Add documentation for Python install manager's install_dir, global_dir and download_dir (GH-140223)
(cherry picked from commit 336154f4b0)

Co-authored-by: Steve Dower <steve.dower@python.org>
2025-11-11 20:08:52 +00:00
Miss Islington (bot)
7618a40a17
[3.14] gh-139533: fix refs to code without proper markups on turtledemo doc (GH-139534) (#141421)
gh-139533: fix refs to code without proper markups on turtledemo doc (GH-139534)
(cherry picked from commit c903d76832)


gh-139533: fix refs to code without proper markups on turtledemo documentation

Co-authored-by: Marco Barbosa <aureliobarbosa@gmail.com>
2025-11-11 19:42:13 +00:00
Miss Islington (bot)
068bddce88
[3.14] gh-141004: Document PyType_Unwatch (GH-141414) (GH-141418)
gh-141004: Document `PyType_Unwatch` (GH-141414)
(cherry picked from commit 759a048d4b)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-11 17:28:14 +00:00
Sergey B Kirpichev
8b9494099a
[3.14] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) (#141399)
(cherry picked from commit d69447445c)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-11 14:52:37 +01:00
Miss Islington (bot)
a468ba0a9d
[3.14] gh-140379: add hyperlinks to list and set (GH-140399) (#141386)
gh-140379: add hyperlinks to list and set (GH-140399)

add hyperlinks to list and set
(cherry picked from commit 92741c59f8)

Co-authored-by: Krishna Chaitanya <141550576+XChaitanyaX@users.noreply.github.com>
2025-11-11 06:08:45 +00:00
Miss Islington (bot)
6d31d085f0
[3.14] gh-140578: Doc: Remove sencence implying that concurrent.futures.ThreadPoolExecutor does not exist (GH-140689) (#141382)
gh-140578: Doc: Remove sencence implying that concurrent.futures.ThreadPoolExecutor does not exist (GH-140689)

* Doc: Remove sencence implying that concurrent.futures.ThreadPoolExecutor does not exist

Closes GH-140578

* Add NEWS.d entry for gh-140578

---------
(cherry picked from commit 46b58e1bb9)

Co-authored-by: Louis <paternal@users.noreply.github.com>
Co-authored-by: Louis Paternault <spalax@gresille.org>
2025-11-11 04:56:07 +00:00
Miss Islington (bot)
9a5cf6f62c
[3.14] gh-141004: Document missing frame APIs (GH-141189) (GH-141379)
gh-141004: Document missing frame APIs (GH-141189)
(cherry picked from commit 86513f6c2e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 21:42:10 +00:00
Miss Islington (bot)
96820d872f
[3.14] gh-141004: Document PyType_FastSubclass (GH-141313) (GH-141368)
gh-141004: Document `PyType_FastSubclass` (GH-141313)
(cherry picked from commit ed0a5fd8ca)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-10 17:52:15 +00:00
Miss Islington (bot)
63a3737ce7
[3.14] gh-139707: Specify winreg, msvcrt and winsound module availability in docs (GH-140429) (GH-141351)
(cherry picked from commit 13fa313beb)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 17:40:46 +01:00
Miss Islington (bot)
7618754d53
[3.14] gh-141343: Fix swapped words in sorted doc (GH-141357)
(cherry picked from commit 59b793b0dd)

Co-authored-by: Yongzi Li <204532581+Yzi-Li@users.noreply.github.com>
2025-11-10 15:01:30 +00:00
Stan Ulbrych
c12a0bef40
[3.14] gh-139707: Add docs for optional modules (GH-140171) (GH-141204)
(cherry picked from commit d2ce6d708a)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Emma Smith <emma@emmatyping.dev>
Co-authored-by: Author: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-10 15:20:00 +01:00
Miss Islington (bot)
44a3d6c69b
[3.14] gh-140500: Update download.html instructions (GH-141320) (#141347)
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:45:48 +00:00
Miss Islington (bot)
c09a65914d
[3.14] gh-141004: Document pyctype.h macros (GH-141272) (GH-141340)
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:12:55 +00:00
Miss Islington (bot)
b5ae8082a6
[3.14] gh-141004: Document Py_DTSF_* macros (GH-141310) (GH-141329)
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:48:48 +00:00
Miss Islington (bot)
6cbb8cb1f7
[3.14] gh-62480: De-personalize "Partial mocking" section in unittest.mock examples (GH-141321) (#141326)
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:30 -06:00
Miss Islington (bot)
5c345ed61a
[3.14] gh-62480: De-personalize "Mocking Unbound Methods" section in unittest.mock examples (GH-141322) (#141324)
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 17:51:07 -06:00
Miss Islington (bot)
6e659bf645
[3.14] gh-141004: Document PySuper_Type (GH-141315) (GH-141318)
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:04 +00:00
Miss Islington (bot)
86c63099ed
[3.14] gh-140980: document SET_FUNCTION_ATTRIBUTE flag for annotate function (GH-141306) (#141316)
gh-140980: document `SET_FUNCTION_ATTRIBUTE` flag for `annotate` function  (GH-141306)
(cherry picked from commit 6f20ea1e2d)

Co-authored-by: Lakshya Upadhyaya <lakshya.upadhyaya05@gmail.com>
2025-11-09 19:04:48 +00:00
Miss Islington (bot)
428f787d58
[3.14] gh-141004: Document PyClassMethod* and PyStaticMethod* APIs (GH-141296) (GH-141308)
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:39 +00:00
Miss Islington (bot)
86824651bc
[3.14] gh-141004: Document PyFunction_SetKwDefaults (GH-141294) (GH-141304)
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:09 +00:00
Miss Islington (bot)
42878e862a
[3.14] gh-141004: Document PyExceptionInstance* APIs (GH-141301) (GH-141302)
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:24 -05:00
Miss Islington (bot)
a8b27305e8
[3.14] gh-141004: Document Py_func_type_input (GH-141273) (GH-141298)
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:27:53 +00:00
Miss Islington (bot)
cb458715a6
[3.14] gh-141004: document curses C API (GH-141254) (#141292)
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:21 +00:00
Miss Islington (bot)
afa52a101e
[3.14] gh-141004: Document PyWeakref_CheckRefExact (GH-141279) (GH-141290)
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:40:20 +00:00
Miss Islington (bot)
7905374d50
[3.14] gh-141004: Document deprecated aliases for memory allocation (GH-141146) (GH-141288)
gh-141004: Document deprecated aliases for memory allocation (GH-141146)
(cherry picked from commit 1d738dea63)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-09 15:12:52 +00:00
Miss Islington (bot)
432432bfc8
[3.14] gh-141127: Clarify os.symlink() documentation for argument order (GH-141144) (#141278)
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:09 +01:00
Miss Islington (bot)
d8a2b8a4f8
[3.14] gh-141004: Document Py_BUILD_ASSERT* macros (GH-141266) (GH-141269)
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:27:41 +00:00