Commit graph

1877 commits

Author SHA1 Message Date
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)
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)
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)
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)
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)
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
Miss Islington (bot)
f98211852a
[3.14] gh-141004: Document the PyDoc_VAR macro (GH-141263) (GH-141264)
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:18:04 +00:00
Miss Islington (bot)
ba0b8214ea
[3.14] gh-141004: Document PyBUF_WRITEABLE (GH-141255) (GH-141261)
gh-141004: Document `PyBUF_WRITEABLE` (GH-141255)
(cherry picked from commit 5e5fc0404e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-08 17:36:00 +00:00
Miss Islington (bot)
6c50a72efe
[3.14] gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText (GH-141250) (GH-141256)
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:54:06 +00:00
Miss Islington (bot)
41944be1e1
[3.14] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) (#141234)
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:28:01 +00:00
Miss Islington (bot)
de00dde9de
[3.14] gh-141004: Document Py_HASH_* macros (GH-141205) (#141225)
* 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:19:34 +00:00
Miss Islington (bot)
5dc8ecc5bc
[3.14] gh-141004: Document PyTraceBack* APIs (GH-141192) (GH-141210)
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:52:45 +00:00
Miss Islington (bot)
b59832041a
[3.14] gh-141004: Document PyErr_WarnExplicitFormat (GH-141187) (GH-141202)
gh-141004: Document `PyErr_WarnExplicitFormat` (GH-141187)
(cherry picked from commit 9420795b47)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-07 16:26:40 +00:00
Miss Islington (bot)
9f8ec95bb0
[3.14] gh-141004: Document PyCapsule_Type (GH-141079) (GH-141199)
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:43 +00:00
Miss Islington (bot)
28493a5a62
[3.14] Update NaNs handling description in c-api/float.rst (GH-141179) (#141194)
Update NaNs handling description in `c-api/float.rst` (GH-141179)

Clarified the behavior of NaNs on IEEE platforms regarding signaling and quiet NaNs.
(cherry picked from commit 920286d6b2)

Co-authored-by: W. H. Wang <mattwang44@gmail.com>
2025-11-07 13:40:59 +00:00
Miss Islington (bot)
7c3539bd09
[3.14] Clarify argument/result ownership/validity for PyModule_* functions (GH-141159) (GH-141190)
(cherry picked from commit ffd64737d0)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-07 13:23:29 +00:00
Miss Islington (bot)
5c2476a4c9
[3.14] gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit (GH-141151) (GH-141156)
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>
2025-11-06 16:45:31 +00:00
Miss Islington (bot)
5d10409e33
[3.14] gh-141004: Document PyLong_FromPid and PyLong_AsPid (GH-141028) (GH-141142)
gh-141004: Document `PyLong_FromPid` and `PyLong_AsPid` (GH-141028)
(cherry picked from commit bcc524f82d)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-06 14:07:56 +00:00
Miss Islington (bot)
eac7b9fa97
[3.14] gh-141004: Document Py_hexdigits (GH-141059) (GH-141138)
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:41 +00:00
Miss Islington (bot)
cd5508d322
[3.14] gh-141004: Document built-in iterator types in the C API (GH-141006) (GH-141134)
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:02 +00:00
Hugo van Kemenade
7168553c00
[3.14] gh-138189: Document type slots, and other constants, as part of Limited API (GH-138190) (GH-141131)
(cherry picked from commit d81e1ef0f3)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-06 12:39:19 +01:00
Miss Islington (bot)
5561837085
[3.14] gh-141004: Document PyDict_GET_SIZE (GH-141078) (GH-141082)
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:38:20 +00:00
Miss Islington (bot)
090c0f1403
[3.14] gh-141004: Document Py_RETURN_NAN and Py_RETURN_INF (GH-141029) (GH-141074)
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:05:47 +00:00
Miss Islington (bot)
378912975b
[3.14] gh-141004: Document PyMemoryView_Type (GH-141034) (GH-141054)
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:34 +00:00
Miss Islington (bot)
39ca786918
[3.14] gh-141004: Document missing iterator types in the C API (GH-141010) (GH-141046)
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:20:04 +00:00
Miss Islington (bot)
7ab08d2c51
[3.14] gh-141004: Document Py_UNICODE_{HIGH, LOW}_SURROGATE functions (GH-141019) (GH-141027)
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:33:52 +00:00
Hugo van Kemenade
25a2a60371
[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-04 09:46:08 +02:00
Miss Islington (bot)
6ab4dfb560
[3.14] Docs: avoid informal formulation in Doc/c-api/conversion.rst (GH-140898) (#140912)
Docs: avoid informal formulation in `Doc/c-api/conversion.rst` (GH-140898)
(cherry picked from commit 173cc53d9f)

Co-authored-by: RayXu <140802139+F18-Maverick@users.noreply.github.com>
2025-11-02 13:57:26 +00:00
Miss Islington (bot)
4d7fab9b15
[3.14] Docs: fix some grammatical errors in Doc/c-api/dict.rst (GH-140899) (#140901)
Docs: fix some grammatical errors in `Doc/c-api/dict.rst` (GH-140899)
(cherry picked from commit d12cbf2865)

Co-authored-by: RayXu <140802139+F18-Maverick@users.noreply.github.com>
2025-11-02 08:38:56 +00:00
Miss Islington (bot)
5ae4612e72
[3.14] Docs: Replace "encoder" with "decoder" in Doc/c-api/codec.rst (GH-140613) (#140661)
Docs: Replace "encoder" with "decoder" in `Doc/c-api/codec.rst` (GH-140613)
(cherry picked from commit d12086e822)

Co-authored-by: RayXu <140802139+F18-Maverick@users.noreply.github.com>
2025-10-27 09:51:14 +00:00
Miss Islington (bot)
57ba6aedf6
[3.14] Docs: Fix a grammatical error in Doc/c-api/codec.rst (GH-140612) (#140616)
Docs: Fix a grammatical error in `Doc/c-api/codec.rst` (GH-140612)
(cherry picked from commit 33b2ca80bb)

Co-authored-by: RayXu <140802139+F18-Maverick@users.noreply.github.com>
2025-10-26 09:45:34 +00:00
Miss Islington (bot)
62c9d48378
[3.14] Fix typo in Doc/c-api/code.rst (GH-140586) (#140591)
Fix typo in `Doc/c-api/code.rst` (GH-140586)
(cherry picked from commit d74a96366d)

Co-authored-by: RayXu <140802139+F18-Maverick@users.noreply.github.com>
2025-10-25 15:41:04 +00:00
Miss Islington (bot)
568cf8b4af
[3.14] Docs: Fix a grammatical error in Doc/c-api/capsule.rst (GH-140577) (GH-140580)
Docs: Fix a grammatical error in `Doc/c-api/capsule.rst` (GH-140577)

"who" -> "which"
(cherry picked from commit 4ad599501f)

Co-authored-by: RayXu <140802139+F18-Maverick@users.noreply.github.com>
2025-10-25 14:02:20 +00:00
Miss Islington (bot)
a975bea9b5
[3.14] Document that PyModule_GetDef can return NULL with or without setting an exception (GH-140529) (GH-140545)
(cherry picked from commit 289360ae63)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-10-24 13:36:35 +00:00
Miss Islington (bot)
4bb2f1f322
[3.14] Docs: Fix a grammatical error in Doc/c-api/arg.rst (GH-140525) (GH-140538)
Docs: Fix a grammatical error in `Doc/c-api/arg.rst` (GH-140525)

"have" -> "has"
(cherry picked from commit fc2e23c2ed)

Co-authored-by: RayXu <140802139+F18-Maverick@users.noreply.github.com>
2025-10-24 12:24:26 +00:00
Miss Islington (bot)
3cef7801dd
[3.14] gh-107073: fix relevant typo in PyObject_ClearManagedDict (GH-140032) (#140033)
gh-107073: fix relevant typo in `PyObject_ClearManagedDict` (GH-140032)
(cherry picked from commit 52996aaa78)

Co-authored-by: Mikhail Efimov <efimov.mikhail@gmail.com>
2025-10-13 11:30:27 +00:00
Miss Islington (bot)
08faef865c
[3.14] gh-101100: Fix reference warnings in c-api/init.rst documenting PyGILState_STATE (GH-139572) (#139832)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-10-09 09:41:57 +00:00
Miss Islington (bot)
8db6615886
[3.14] gh-129368: In PyRun C API docs, clarify what a "start token" is (GH-129935) (#139042)
gh-129368: In PyRun C API docs, clarify what a "start token" is (GH-129935)
(cherry picked from commit e1eca8b308)

Co-authored-by: Rajhans Jadhao <rajhans.jadhao@gmail.com>
2025-10-07 19:30:05 +01:00
Miss Islington (bot)
f899c849d4
[3.14] Remove unmatched closing parenthesis (GH-139082) (#139099)
Remove unmatched closing parenthesis (GH-139082)
(cherry picked from commit d22b25081b)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2025-10-07 19:24:17 +01:00
Miss Islington (bot)
292b6cf3e6
[3.14] Document Py_AddPendingCall() change with subinterpreters in 3.12 (GH-139117) (#139118)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-10-03 23:20:35 +03:00
Miss Islington (bot)
1ae1db8056
[3.14] Document that PyInterpreterState_GetDict returns a borrowed reference (GH-139451) (#139463)
Document that `PyInterpreterState_GetDict` returns a borrowed reference (GH-139451)
(cherry picked from commit 80cdf3ef74)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-10-01 08:39:54 +03:00