Commit graph

1950 commits

Author SHA1 Message Date
Stan Ulbrych
0ac890bea7
gh-141004: Document Py_BUILD_ASSERT* macros (GH-141266) 2025-11-08 14:22:05 -05:00
Stan Ulbrych
545299773b
gh-141004: Document the PyDoc_VAR macro (GH-141263) 2025-11-08 13:12:03 -05:00
Peter Bierma
5e5fc0404e
gh-141004: Document PyBUF_WRITEABLE (GH-141255) 2025-11-08 12:29:31 -05:00
Peter Bierma
be1c72a45d
gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText (GH-141250)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 10:47:09 -05:00
Bénédikt Tran
87942d911b
gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (#141233) 2025-11-08 12:22:02 +00:00
Bénédikt Tran
8cec3d3a9d
gh-141004: fix versionadded typo for Py_HASH_SIPHASH13 (#141223) 2025-11-08 09:10:27 +00:00
Peter Bierma
d13ee0ae18
gh-141004: Document PyTraceBack* APIs (GH-141192)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-07 13:46:47 -05:00
Bénédikt Tran
3989e12d39
gh-141004: Document Py_HASH_* macros (#141205) 2025-11-07 19:25:32 +01:00
Peter Bierma
9420795b47
gh-141004: Document PyErr_WarnExplicitFormat (GH-141187) 2025-11-07 11:19:14 -05:00
Peter Bierma
7af9b5354d
gh-141004: Document PyCapsule_Type (GH-141079) 2025-11-07 09:09:38 -05:00
W. H. Wang
920286d6b2
Update NaNs handling description in c-api/float.rst (#141179)
Clarified the behavior of NaNs on IEEE platforms regarding signaling and quiet NaNs.
2025-11-07 14:34:49 +01:00
Petr Viktorin
ffd64737d0
Clarify argument/result ownership/validity for PyModule_* functions (GH-141159)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-07 14:17:47 +01:00
Peter Bierma
0b260305d3
gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit (GH-141151)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-06 16:37:52 +00:00
Peter Bierma
bcc524f82d
gh-141004: Document PyLong_FromPid and PyLong_AsPid (GH-141028)
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-06 09:01:48 -05:00
Stan Ulbrych
54110e20e0
gh-141004: Document Py_hexdigits (GH-141059)
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-06 08:48:42 -05:00
Peter Bierma
1697cb5710
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.
2025-11-06 07:29:04 -05:00
RayXu
9037a386c6
docs: fix a grammatical error in function.rst (#140990) 2025-11-06 11:18:30 +05:30
Peter Bierma
f0ab07f22c
gh-141004: Document PyDict_GET_SIZE (GH-141078) 2025-11-05 17:32:12 -05:00
Peter Bierma
5b02c6e920
gh-141004: Document Py_RETURN_NAN and Py_RETURN_INF (GH-141029)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-11-05 17:00:26 -05:00
Peter Bierma
3f6aca1be4
gh-141004: Document PyMemoryView_Type (GH-141034) 2025-11-05 11:45:13 -05:00
Peter Bierma
35528fccdc
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

---------

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-05 09:13:57 -05:00
Petr Viktorin
d81e1ef0f3
gh-138189: Document type slots, and other constants, as part of Limited API (GH-138190)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-04 22:58:53 +01:00
Stan Ulbrych
bfe54810c4
gh-141004: Document Py_UNICODE_{HIGH, LOW}_SURROGATE functions (GH-141019) 2025-11-04 16:19:06 -05:00
Petr Viktorin
3f2b83e959
Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
RayXu
173cc53d9f
Docs: avoid informal formulation in Doc/c-api/conversion.rst (#140898) 2025-11-02 13:49:49 +00:00
Sergey Miryanov
da65f38a94
gh-134786: raise error if Py_TPFLAGS_MANAGED_WEAKREF or Py_TPFLAGS_MANAGED_DICT is used without Py_TPFLAGS_HAVE_GC set (#135863) 2025-11-02 16:34:49 +05:30
RayXu
d12cbf2865
Docs: fix some grammatical errors in Doc/c-api/dict.rst (#140899) 2025-11-02 09:31:26 +01:00
RayXu
d12086e822
Docs: Replace "encoder" with "decoder" in Doc/c-api/codec.rst (#140613) 2025-10-27 10:43:24 +01:00
da-woods
f5da369e20
Fix typo in TLS docs (#140640) 2025-10-27 10:28:30 +05:30
RayXu
33b2ca80bb
Docs: Fix a grammatical error in Doc/c-api/codec.rst (#140612) 2025-10-26 10:39:32 +01:00
RayXu
d74a96366d
Fix typo in Doc/c-api/code.rst (#140586) 2025-10-25 17:34:45 +02:00
RayXu
4ad599501f
Docs: Fix a grammatical error in Doc/c-api/capsule.rst (GH-140577)
"who" -> "which"
2025-10-25 09:54:52 -04:00
Petr Viktorin
289360ae63
Document that PyModule_GetDef can return NULL with or without setting an exception (GH-140529) 2025-10-24 15:28:48 +02:00
RayXu
fc2e23c2ed
Docs: Fix a grammatical error in Doc/c-api/arg.rst (GH-140525)
"have" -> "has"
2025-10-24 08:17:52 -04:00
Peter Holloway
3c2781dc5f
Fix typo in PyIter_Send docs (#140336) 2025-10-20 14:23:57 +05:30
Tomasz Dądela
67c98ad8ef
gh-133059: Update documentation of preallocated integer range in long.rst (GH-140231) 2025-10-17 06:32:02 -04:00
Tan Long
2ebd0cdb16
Remove duplicate words in the documentation (#140221) 2025-10-16 18:27:00 +01:00
Victor Stinner
4126d9f1ab
gh-129813: Enhance PyBytesWriter documentation (#140152)
Co-authored-by: Antoine Pitrou <pitrou@free.fr>
2025-10-15 14:54:18 +02:00
Hugo van Kemenade
aeff92d86a Python 3.15.0a1 2025-10-14 13:46:08 +03:00
Mikhail Efimov
52996aaa78
gh-107073: fix relevant typo in PyObject_ClearManagedDict (#140032) 2025-10-13 13:23:09 +02:00
Dino Viehland
ff7bb565d8
gh-139924: Add PyFunction_PYFUNC_EVENT_MODIFY_QUALNAME event for function watchers (#139925)
Add PyFunction_PYFUNC_EVENT_MODIFY_QUALNAME event for function watchers
2025-10-10 15:25:38 -07:00
Victor Stinner
d0b18b19fa
gh-129813: Fix PyBytesWriter tests (#139892) 2025-10-10 13:01:06 +02:00
Victor Stinner
e31c22dbf9
gh-111489: Add PyTuple_FromArray() function (#139691) 2025-10-10 08:54:12 +02:00
Stan Ulbrych
d2deb8fdef
gh-101100: Fix reference warnings in c-api/init.rst documenting PyGILState_STATE (#139572) 2025-10-09 12:34:35 +03:00
Petr Viktorin
80cdf3ef74
Document that PyInterpreterState_GetDict returns a borrowed reference (#139451) 2025-10-01 09:46:06 +05:30
Bénédikt Tran
a5e0562350
gh-133644: remove PyWeakref_GetObject and PyWeakref_GET_OBJECT (GH-133657) 2025-09-24 11:25:56 +02:00
Peter Bierma
89ff88be89
Document Py_AddPendingCall() change with subinterpreters in 3.12 (GH-139117)
Prior to 3.9, Py_AddPendingCall() would always run pending calls in the main interpreter, but then each interpreter got their own ceval state, and they were scheduled for any interpreter. In GH-104813, this was undone, so Py_AddPendingCall() would always schedule for the main interpreter.
2025-09-18 12:10:41 +00:00
Rafael Fontenelle
d22b25081b
Remove unmatched closing parenthesis (GH-139082) 2025-09-18 10:01:09 +01:00
Rajhans Jadhao
e1eca8b308
gh-129368: In PyRun C API docs, clarify what a "start token" is (#129935) 2025-09-17 14:51:20 +00:00
Victor Stinner
9a8bc6d4a4
gh-129813, PEP 782: Add doc reference link (#138986) 2025-09-16 15:51:45 +02:00