1794 Commits

Author SHA1 Message Date
Nathan Goldbaum
b5129b89bb
[3.13] gh-144257: document return values of PyModule_SetDocString (GH-144258) (GH-144286)
(cherry picked from commit 3e9a5b022f01fa95b4485fcf2c0c87bfb9fff837)

Co-authored-by: sobolevn <mail@sobolevn.me>
2026-01-27 18:30:48 +00:00
Miss Islington (bot)
d4d37b26cb
[3.13] gh-141004: Mark up constants for PyOS_double_to_string (GH-143867) (GH-144147)
gh-141004: Mark up constants for `PyOS_double_to_string` (GH-143867)

This ensures they show up as C macros in search and the Sphinx inventory.
(cherry picked from commit fb690c38cafb15e4ccddc52aba37f9470ce201a0)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-01-22 13:30:31 +01:00
Miss Islington (bot)
9a3aea9fd5
[3.13] gh-141004: Mark up docs of old PyMem macros (GH-143783) (GH-143865)
gh-141004: Mark up docs of old PyMem macros (GH-143783)

These had a docs-only deprecation notice since the first version of the docs in this repo. Nowadays we call things “soft deprecated” if there's just a note in the docs.

The deprecated directive needs a version, I went with the first one that had the notice (2.0; it's not in 1.6):
- https://docs.python.org/release/2.0/api/memoryInterface.html
- https://docs.python.org/release/1.6/api/memoryInterface.html

Since PEP 445, they are now direct aliases; there are no (additional) binary compatibility concerns over the preferred names.
(cherry picked from commit a009e78b79ec340d9ff0e1a8ad20f8178fd3257f)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-01-22 11:52:12 +01:00
Miss Islington (bot)
343b5c4421
[3.13] gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) (GH-143508) (GH-143787)
(cherry picked from commit a7ba3b124f707f73b94b59f13908872f1a48e24f)

Co-authored-by: Yashraj <yashrajpala8@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2026-01-15 13:34:37 +01:00
Miss Islington (bot)
2516dd0d06
[3.13] gh-143834: Fix PyLong_AsNativeBytes docs for negative number padding (GH-143840) (GH-143855)
(cherry picked from commit 421bd1770a87d141f66754ae29e407589e44ce83)

Co-authored-by: Muneeb Ullah <moneebullah25@gmail.com>
2026-01-15 09:34:21 +01:00
Miss Islington (bot)
5f7a49a77b
[3.13] gh-141004: Document old provisional names for vectorcall/code API (GH-143568) (GH-143829)
For vectorcall API, the underscore-prefixed provisional names
continue to be available per PEP 590:
https://peps.python.org/pep-0590/#finalizing-the-api
Use `versionadded`, `versionchanged`, and `:no-typesetting:`
to mark this up.

For PyCode API, use `:no-typesetting:` rather than `index::` so that
these are semantically documented as C functions.
(cherry picked from commit 7e8a1b5061313e03f99bc2ffa2062702bcc76426)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-01-14 11:01:54 +01:00
Miss Islington (bot)
2c3e3ef6a2
[3.13] gh-123241: Document restrictions for tp_traverse implementations (gh-142272) (#142422)
(cherry picked from commit 37988c57ea244b0ed2f969e9c6039710dfe8f31d)

Co-authored-by: Sam Gross <colesbury@gmail.com>
2025-12-08 17:28:21 +00:00
Stan Ulbrych
a12841c197
[3.13] gh-101100: Fix references to the set methods (GH-141857) (GH-142345)
(cherry picked from commit 1d8f3ed2eba762e60a02ff87e782a5c7dcd0e77c)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-12-08 09:50:43 +02:00
Miss Islington (bot)
f61e9fcdb6
[3.13] gh-141004: Document descriptor and dict proxy type objects (GH-141803) (GH-142148)
gh-141004: Document descriptor and dict proxy type objects (GH-141803)
(cherry picked from commit 52f9b5f580b6b85dbf08fa23103d17a60455bc20)

Co-authored-by: Yashraj <yashrajpala8@gmail.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-12-01 15:57:53 +00:00
Stan Ulbrych
3bbd669abb
[3.13] gh-141004: Document PyImport_Inittab (GH-141844) (GH-142016)
(cherry picked from commit 5f35702bb641230131c400500bb8bbacde7465b2)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-27 14:20:58 -05:00
Petr Viktorin
9756d8c637
[3.13] gh-141909: Add PyModuleDef_Slot and earlier Py_mod_* constants to stable ABI manifest (#141910) (GH-141977)
These were added to the limited API in 3.5-3.12.
Not including them in `Misc/stable_abi.toml` was a bug.

(cherry picked from commit 202fce0dbde1da32d8abc2eb59ddfce6f6a3c9fa)
2025-11-26 15:34:57 +01:00
Miss Islington (bot)
0e3d1b8670
[3.13] gh-141004: Document missing PyThread* APIs (GH-141810) (GH-141955)
* gh-141004: Document missing `PyThread*` APIs (GH-141810)
(cherry picked from commit a89ee4b9c2a87d9bdf105883f834cda9d943d541)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-25 18:04:42 +00:00
Miss Islington (bot)
fffa6c9ab8
[3.13] gh-141004: Document PyOS_mystr(n)icmp (GH-141760) (#141948)
gh-141004: Document `PyOS_mystr(n)icmp` (GH-141760)
(cherry picked from commit f445c452ea879e01b4144809a5fd8826ac98f305)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-25 13:51:59 +00:00
Miss Islington (bot)
7905e85ecd
[3.13] gh-141004: Document stack effect C APIs (GH-141843) (GH-141917)
gh-141004: Document stack effect C APIs (GH-141843)
(cherry picked from commit e1f1df4082e2bc6cdb46be9984124c88a7b2ff0f)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-24 17:26:12 +00:00
Miss Islington (bot)
2701e8e542
[3.13] gh-141004: Document Py_ARRAY_LENGTH (GH-141601) (GH-141896)
gh-141004: Document `Py_ARRAY_LENGTH` (GH-141601)
(cherry picked from commit e0773eacb7e660b4fd6bd702b0a119e25ab3b012)

Co-authored-by: Yashraj <yashrajpala8@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-24 13:40:39 +00:00
Miss Islington (bot)
79e0f6f684
[3.13] gh-141004: Document Py_MakePendingCalls (GH-141137) (GH-141788)
gh-141004: Document `Py_MakePendingCalls` (GH-141137)
(cherry picked from commit ce701032a3d5d3597466d5836ebe989db6eda2aa)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-20 14:30:51 +00:00
Miss Islington (bot)
7a27c7b2e4
[3.13] gh-141004: Document missing PyDateTime* APIs (GH-141543) (GH-141792)
gh-141004: Document missing `PyDateTime*` APIs (GH-141543)
(cherry picked from commit 4273616ebfbfe2a7cfd93460a08364f5a40f89e2)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-20 13:55:17 +00:00
Miss Islington (bot)
e90d8953a0
[3.13] gh-141004: Document missing generator APIs (GH-141409) (GH-141790)
gh-141004: Document missing generator APIs (GH-141409)
(cherry picked from commit 2da7ecc680548804ea99d62ba4d228cfa5011671)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-20 13:52:36 +00:00
Miss Islington (bot)
49ac2bbe02
[3.13] gh-141004: Document Py_LOCAL and Py_LOCAL_INLINE (GH-141725) (GH-141762)
gh-141004: Document `Py_LOCAL` and `Py_LOCAL_INLINE` (GH-141725)
(cherry picked from commit 3149d64c93f02217eb01c0fd82c26a685b5281c1)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-19 18:38:53 +00:00
Sergey B Kirpichev
a5650e42ac
[3.13] gh-141004: Document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN (GH-141544) (#141700)
(cherry picked from commit 630cd37bfae0fc4021d9e9461b94d36e7ce6b95c)

Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-18 14:32:48 +01:00
Miss Islington (bot)
d4e4924a5f
[3.13] gh-141004: Document PyODict* APIs (GH-141136) (GH-141678)
gh-141004: Document `PyODict*` APIs (GH-141136)
(cherry picked from commit b3626321b6ebb46dd24acee2aa806450e70febfc)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-17 19:47:04 +00:00
Miss Islington (bot)
e6f429c30d
[3.13] gh-141004: Document missing PyCFunction* and PyCMethod* APIs (GH-141253) (GH-141638)
gh-141004: Document missing `PyCFunction*` and `PyCMethod*` APIs (GH-141253)
(cherry picked from commit be699d6c7c8793d3eb464f2e5d3f10262fe3bc37)

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:32:16 +00:00
Miss Islington (bot)
7b5c65a32f
[3.13] gh-141004: Document the PyPickleBuffer_* C API (GH-141630) (GH-141633)
gh-141004: Document the `PyPickleBuffer_*` C API (GH-141630)
(cherry picked from commit e33afa7ddbca3fca38f4ec4369b620c37cb092e2)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-16 18:58:19 +00:00
Miss Islington (bot)
c8c8cc2e8f
[3.13] gh-141004: Document PyOS_InterruptOccurred (GH-141526) (GH-141550)
gh-141004: Document `PyOS_InterruptOccurred` (GH-141526)
(cherry picked from commit ef90261be508b97d682589aac8f00065a9585683)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-14 15:58:19 +00:00
Miss Islington (bot)
baa9216159
[3.13] gh-141004: Document PyErr_RangedSyntaxLocationObject (GH-141521) (#141524)
gh-141004: Document `PyErr_RangedSyntaxLocationObject` (GH-141521)

PyErr_RangedSyntaxLocationObject
(cherry picked from commit 196f1519cd2d8134d7643536f13f2b2844bea65d)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-13 18:05:43 +00:00
Miss Islington (bot)
c86f5d3ebe
[3.13] gh-141004: Document PyCode_Optimize (GH-141378) (GH-141515)
gh-141004: Document `PyCode_Optimize` (GH-141378)
(cherry picked from commit d7862e9b1bd8f82e41c4f2c4dad31e15707d856f)

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

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-13 15:09:23 +00:00
Petr Viktorin
6916bfb800
[3.13] gh-138189: Document type slots, and other constants, as part of Limited API (GH-138190) (GH-141193)
(cherry picked from commit d81e1ef0f3a7c63f5d246e4cf918700016b72489)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-13 13:28:57 +01:00
Peter Bierma
39de3f87c1
[3.13] gh-141004: Document PyType_SUPPORTS_WEAKREFS (GH-141408) (GH-141487)
* gh-141004: Document `PyType_SUPPORTS_WEAKREFS` (GH-141408)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
(cherry picked from commit 9cd5427d9619b96db20d0347a136b3d331af71ae)
2025-11-12 23:02:58 +00:00
Miss Islington (bot)
f127ff7daf
[3.13] gh-141004: Document PyRun_InteractiveOneObject (GH-141405) (GH-141486)
gh-141004: Document `PyRun_InteractiveOneObject` (GH-141405)
(cherry picked from commit 26b7df2430cd5a9ee772bfa6ee03a73bd0b11619)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-12 22:59:55 +00:00
Miss Islington (bot)
7ca34db12b
[3.13] gh-141004: Document Py_MATH_{E, PI, TAU} constants (GH-141373) (#141472)
gh-141004: Document `Py_MATH_{E, PI, TAU}` constants (GH-141373)
(cherry picked from commit f1330b35b8eb43904dfed0656acde80c08d63176)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-12 17:03:55 +00:00
Miss Islington (bot)
c317cf51f1
[3.13] gh-141370: document undefined behavior of Py_ABS() (GH-141439) (GH-141455)
(cherry picked from commit 20f53df07d42c495a08c73a3d54b8dd9098a62f0)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-11-12 09:57:08 +00:00
Peter Bierma
51c60f3681
[3.13] gh-141004: Document PyBytes_Repr and PyBytes_DecodeEscape (GH-141407) (GH-141441)
* 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 37e2762ee12c2d7fc465938d7161a9a0640bd71f)
2025-11-12 02:08:28 +00:00
Miss Islington (bot)
b28ba31c69
[3.13] gh-141004: Document PyFile_OpenCode and PyFile_OpenCodeObject (GH-141413) (GH-141426)
gh-141004: Document `PyFile_OpenCode` and `PyFile_OpenCodeObject` (GH-141413)
(cherry picked from commit 2befce86e699fdbb6610949b029bad56a0d0780f)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-11 16:48:36 -05:00
Miss Islington (bot)
07a6bdd765
[3.13] gh-141004: Document PyType_Unwatch (GH-141414) (GH-141419)
gh-141004: Document `PyType_Unwatch` (GH-141414)
(cherry picked from commit 759a048d4bea522fda2fe929be0fba1650c62b0e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-11 17:28:52 +00:00
Sergey B Kirpichev
05e7b0dadf
[3.13] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) (#141400)
(cherry picked from commit d69447445cbacf7537bf59c5c683a3b17060312d)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-11 14:52:05 +01:00
Miss Islington (bot)
a8c9aff84f
[3.13] gh-141004: Document missing frame APIs (GH-141189) (GH-141380)
gh-141004: Document missing frame APIs (GH-141189)
(cherry picked from commit 86513f6c2ebdd1fb692c39b84786ea41d88c84fd)

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

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-10 17:52:22 +00:00
Petr Viktorin
6384c7917d
[3.13] Clarify argument/result ownership/validity for PyModule_* functions (GH-141159) (GH-141191)
(cherry picked from commit ffd64737d00277eea1c4721d278a0951168d07ca)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-10 15:06:58 +01: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 df192616212f80aaa2f672b722b925943dbd3b78)

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 9b0179fa87fee39df0f75bd84fc2dd75f1d00553)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 00:49:30 +00: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 14c62227f9fa11fb743f9e03dcc5aab553de1098)

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 807db68ddd8572cfa825373bc13461b02691f4d9)

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 18529b580b59b8d075641da6c685bef377eb0a7b)

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 b5a0c72492800c7e999b87adfcfeabaacb4ecb97)

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 8dd849828636bb3989c6d5d20f8790a3fb770fc4)

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 dbe40904a78a0c8ffa25fb64e6ff1e14e6e7ba5a)

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 60155329a0a83a2b9e740f0c0de41c9d44f5a053)

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 1d738dea6364de004f8cec7c6309d6bbd3b996c7)
2025-11-09 15:37:13 +00: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 0ac890bea79d3e0162c8909b0999f626f1141d89)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 19:28:32 +00:00