summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] GH-69695: Update ``PyImport_ImportModule`` description (GH-103836) ↵Miss Islington (bot)2024-02-051-14/+2
| | | | | | | | | | | (GH-114924) GH-69695: Update ``PyImport_ImportModule`` description (GH-103836) (cherry picked from commit 9872855a31720f514b84373848b49fca09d66ecd) Co-authored-by: patenaud <33957588+patenaud@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-101100: Fix sphinx warnings in `Doc/c-api/memoryview.rst` ↵Miss Islington (bot)2024-01-291-0/+13
| | | | | | | (GH-114669) (GH-114705) (cherry picked from commit 97fb2480e4807a34b8197243ad57566ed7769e24) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] Fix `c-api/file.rst` indexes (GH-114608) (GH-114639)Miss Islington (bot)2024-01-271-2/+3
| | | | | (cherry picked from commit 23fb9f0777b054526b3b32f58e60b2a03132bf45) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891) (GH-114637)Miss Islington (bot)2024-01-271-6/+2
| | | | | (cherry picked from commit 926881dc10ebf77069e02e66eea3e0d3ba500fe5) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.11] Document PyOS_strtoul and PyOS_strtol (GH-114048) (GH-114619)Miss Islington (bot)2024-01-261-0/+36
| | | | | (cherry picked from commit 3f62bf32caf04cedb2c59579a0ce835d1e793d4d) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.11] gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546) (#114585)Miss Islington (bot)2024-01-262-2/+15
| | | | | Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.11] gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373) ↵Miss Islington (bot)2024-01-211-2/+2
| | | | | | | | (#114378) gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373) (cherry picked from commit 47133d8d869c94c4d1f340b5481cc3f2cdc7d68b) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-112092: clarify unstable ABI recompilation requirements ↵Miss Islington (bot)2024-01-181-1/+1
| | | | | | | | | | (GH-112093) (#114261) gh-112092: clarify unstable ABI recompilation requirements (GH-112093) Use different versions in the examples for when extensions do and do not need to be recompiled to make the examples easier to understand. (cherry picked from commit 68a7b78cd5185cbd9456f42c15ecf872a7c16f44) Co-authored-by: DerSchinken <53398996+DerSchinken@users.noreply.github.com>
* [3.11] gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` ↵Miss Islington (bot)2024-01-171-0/+34
| | | | | | | | | (GH-112557) (GH-114120) gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557) (cherry picked from commit a482bc67ee786e60937a547776fcf9528810e1ce) Co-authored-by: AN Long <aisk@users.noreply.github.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.11] docs: specify that PyBytes_AsStringAndSize returns 0 on success ↵Miss Islington (bot)2023-12-251-0/+1
| | | | | | | (GH-110888) (GH-111691) (cherry picked from commit 9f33ede12710c454643c394421f52d209247272c) Co-authored-by: lefp <70862148+lefp@users.noreply.github.com>
* [3.11] gh-101100: Improve docs on exception attributes (GH-113057) (#113062)Miss Islington (bot)2023-12-131-6/+10
| | | | | | | gh-101100: Improve docs on exception attributes (GH-113057) (cherry picked from commit d05a180350fe20d5fde56c7e525e394a0b282703) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.11] gh-101100: Further improve docs on function attributes (#113001) ↵Alex Waygood2023-12-121-1/+1
| | | | | (#113031) (cherry-picked from commit 81a15ea74e)
* [3.11] gh-101100: Improve documentation on function attributes (#112933) ↵Alex Waygood2023-12-121-10/+13
| | | | | | (#113003) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-101100: Improve documentation of code object attributes (#112781) ↵Alex Waygood2023-12-062-3/+3
| | | | | (#112817) (cherry-picked from commit e9707d3c3d)
* [3.11] gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` ↵Miss Islington (bot)2023-12-061-3/+3
| | | | | | | | | | | | | parameters in slot typedefs table (GH-112742) (GH-112793) gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` parameters in slot typedefs table (GH-112742) In the slot typedefs table, the parameter of `destructor` and the first parameter of `traverseproc` should both be `PyObject *` rather than `void *`. Same for `inquiry`. (cherry picked from commit 00cce0fe495ee820cd3ca5878bdbe3dd65b1be7b) Co-authored-by: Christopher Chavez <chrischavez@gmx.us>
* [3.11] gh-101100: Properly document frame object attributes (#112735) (#112775)Alex Waygood2023-12-052-6/+7
| | | | | * [3.11] gh-101100: Properly document frame object attributes (#112735) (cherry-picked from commit d109f637c0)
* [3.11] gh-62897: Update PyUnicode C API parameter names (GH-12680) (GH-112745)Serhiy Storchaka2023-12-051-97/+97
| | | | | | | Standardize PyUnicode C API parameter names across the documentation. (cherry picked from commit b31232ddf7f219ca8ff9e8d0401c02eb0b6ffec3) Co-authored-by: Rune Tynan <runetynan@gmail.com>
* [3.11] gh-101100: Fix Sphinx reference warnings (GH-112416) (#112422)Hugo van Kemenade2023-11-261-1/+1
|
* [3.11] Add a version added note for PY_VECTORCALL_ARGUMENTS_OFFSET ↵Miss Islington (bot)2023-10-231-0/+2
| | | | | | (GH-110963) (#111220) Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
* [3.11] C-API docs: Clarify the size of arenas (GH-110895) (#110947)Miss Islington (bot)2023-10-161-1/+2
| | | | | | | | | | | C-API docs: Clarify the size of arenas (GH-110895) Clarify the size of arenas From 3.10.0 alpha 7, the pymalloc allocator uses arenas with a fixed size of 1 MiB on 64-bit platforms instead of 256 KiB on 32-bit platforms. (cherry picked from commit f07ca27709855d4637b43bba23384cc795143ee3) Co-authored-by: Mienxiu <82512658+mienxiu@users.noreply.github.com>
* [3.11] gh-110527: Improve `PySet_Clear` docs (GH-110528) (#110927)Miss Islington (bot)2023-10-161-1/+3
| | | | | | gh-110527: Improve `PySet_Clear` docs (GH-110528) (cherry picked from commit bfc1cd8145db00df23fbbd2ed95324bb96c0b25b) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-110631: Fix reST indentation (GH-110724) (#110739)Ezio Melotti2023-10-111-12/+12
| | | | | | * Fix wrong indentation in the other dirs. * Fix more wrong indentation.. (cherry picked from commit 718391f475f2550d99dd794069ca76312f7f6aa6)
* [3.11] gh-102304: Add links to the Stable ABI and Limited C API docs ↵Adam Turner2023-09-296-25/+38
| | | | | | (#105345) (#105371) (#109901) * Add "limited-c-api" and "stable-api" targets * Rename the "stable-abi-list" target to "limited-api-list"
* [3.11] gh-107298: Document PyMODINIT_FUNC macro (#109236) (#109948)Victor Stinner2023-09-271-0/+24
| | | | | | | | | | | gh-107298: Document PyMODINIT_FUNC macro (#109236) Document PyMODINIT_FUNC macro. Remove links to PyAPI_FUNC() and PyAPI_DATA() macros since they are not documented. These macros should only be used to define the Python C API. They should not be used outside Python code base. (cherry picked from commit d7a27e527d7e669d2e45cff80ad725978226477c)
* [3.11] Improve some C API documentation (GH-108768) (GH-108786)Serhiy Storchaka2023-09-023-44/+43
| | | | | | | | * Express functions which take argument as a C string in terms of functions which take Python object. * Use "note" directive for PyMapping_HasKey() and PyMapping_HasKeyString() notes. (cherry picked from commit 6f97eeec222f81bd7ae836c149872a40b079e2a6)
* [3.11] [3.12] gh-108314: PyDict_GetItemString() mentions UTF-8 (GH-108448) ↵Miss Islington (bot)2023-08-251-3/+5
| | | | | | | | | | | | | (#108489) [3.12] gh-108314: PyDict_GetItemString() mentions UTF-8 (GH-108448) gh-108314: PyDict_GetItemString() mentions UTF-8 PyDict_GetItemString(), PyDict_SetItemString() and PyDict_DelItemString() expects a UTF-8 encoding string for the key. (cherry picked from commit 9a225d7d5b0530ee73fa00d4816897997a9eb733) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] gh-107298: Fix numerous ref errors and typos in the C API docs ↵Serhiy Storchaka2023-08-224-6/+16
| | | | | (GH-108258) (#108290) (cherry picked from commit d7202e4879bf4e7e00a69500ddcb3143864139b4)
* [3.11] gh-107298: Fix C API datetime documentation (GH-108034) (#108233)Miss Islington (bot)2023-08-221-14/+57
| | | | | (cherry picked from commit d63972e289e05b0d82e59f32f107312a8b3de7b5) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-107298: Fix some references in the C API documentation (GH-108072) ↵Serhiy Storchaka2023-08-171-1/+1
| | | | | (GH-108076) (cherry picked from commit f51f0466c07eabc6177c2f64f70c952dada050e8)
* [3.11] gh-107298: Fix C API Buffer documentation (GH-108011) (#108041)Miss Islington (bot)2023-08-162-10/+14
| | | | | | gh-107298: Fix C API Buffer documentation (GH-108011) (cherry picked from commit c2941cba7a986e6158eebb2a0bf33906dcd78616) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] Docs: Document PyBUF_MAX_NDIM (GH-107865) (#107872)Miss Islington (bot)2023-08-111-3/+7
| | | | | (cherry picked from commit 637f7ff2c60f262659da0334f1cb672bd361f398) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.11] gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107753)Eric Snow2023-08-0712-79/+113
| | | | | PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has. This change updates the documentation to reflect that perspective.
* [3.11] Fix the documentation for PyCode_New add qualname parameter ↵da-woods2023-07-301-4/+4
| | | | | | (GH-107186) (#107454) [3.11] Fix the documentation for PyCode_New add `qualname` parameter (GH-107186). (cherry picked from commit f2abeb590dae5918388f91b60b31f040d44218f0)
* [3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) ↵Miss Islington (bot)2023-07-291-0/+6
| | | | | | | (GH-107418) (cherry picked from commit f2d07d3289947d10b065b2bb7670c8fb6b6582f2) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) ↵Serhiy Storchaka2023-07-289-26/+39
| | | | | (GH-107381) (cherry picked from commit 983305268e2291b0a7835621b81bf40cba7c27f3)
* [3.11] gh-107298: Fix more Sphinx warnings in the C API doc (GH-107329) ↵Serhiy Storchaka2023-07-2816-67/+70
| | | | | | | | | | | | | | | | | | | (GH-107377) Declare the following functions as macros, since they are actually macros. It avoids a warning on "TYPE" or "macro" argument. * PyMem_New() * PyMem_Resize() * PyModule_AddIntMacro() * PyModule_AddStringMacro() * PyObject_GC_New() * PyObject_GC_NewVar() * PyObject_New() * PyObject_NewVar() (cherry picked from commit 8d61a71f9c81619e34d4a30b625922ebc83c561b) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] gh-107298: Fix Sphinx warnings in the C API doc (GH-107302) (GH-107373)Serhiy Storchaka2023-07-2810-26/+26
| | | | | | (cherry picked from commit 391e03fa05b80d17a14ac88d30c974fa2fa00adb) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] gh-107298: Fix doc references to undocumented modules (GH-107300) ↵Serhiy Storchaka2023-07-284-4/+4
| | | | | | | (GH-107371) (cherry picked from commit 87b39028e5f453a949a1675526c439f6479a04a8) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] gh-107298: Docs: add targets for some :c:member: and :c:macro: ↵Serhiy Storchaka2023-07-272-39/+40
| | | | | | | | references (GH-107316) (GH-107333) Add targets for PyStructSequence_Desc and PyStructSequence_Field members and macros like Py_EQ. Fix target for Py_RETURN_RICHCOMPARE. (cherry picked from commit abec9a1b20b70d8ced401d59fc4f02b331c6568b)
* [3.11] gh-107091: Fix some uses of :attr: role (GH-107318) (GH-107331)Serhiy Storchaka2023-07-276-54/+60
| | | | Fix also formatting of PyMethodDef members. (cherry picked from commit d363eb5b0255c055e7b43f5e2c0847f555e1982e)
* [3.11] gh-107091: Fix some uses of :c:type: role (GH-107138) (GH-107313)Miss Islington (bot)2023-07-262-10/+12
| | | | | (cherry picked from commit 6d5b6e71c87fca7c5c26f5dd8f325087962215cc) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-107091: Fix some uses of :c:member: role (GH-107129) (GH-107311)Serhiy Storchaka2023-07-264-8/+10
| | | (cherry picked from commit af61cb9c7837ff3c11da79e3ee1cab3fdd0ba4da)
* [3.11] Fix PyVectorcall_Function doc versionadded (GH-107140) (#107174)Miss Islington (bot)2023-07-241-1/+1
| | | | | | | | | | Fix PyVectorcall_Function doc versionadded (GH-107140) The documentation implies that PyVectorcall_Function() was available in Python 3.8. This is half-true - it was available under a different name. I think it's clearer to set the "version added" to 3.9. (cherry picked from commit 0a9b339363a59be1249189c767ed6f46fd71e1c7) Co-authored-by: da-woods <dw-git@d-woods.co.uk>
* [3.11] gh-106948: Docs: Disable links for C standard library functions, OS ↵Erlend E. Aasland2023-07-232-3/+3
| | | | | | | utility functions and system calls (#107062) (#107157) (cherry picked from commit b447e19e720e6781025432a40eb72b1cc93ac944) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-107091: Fix the use of some C domain roles (GH-107092) (GH-107121)Serhiy Storchaka2023-07-235-8/+8
| | | (cherry picked from commit 08a228da05a7aec937b65eea21f4091fa3c6b5cf)
* [3.11] gh-101100: Fix some broken sphinx references (GH-107095). (#107120)wulmer2023-07-234-6/+6
|
* [3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) ↵Serhiy Storchaka2023-07-234-10/+10
| | | | | | | (#107061) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".. (cherry picked from commit f8b7fe2f2647813ae8249675a80e59c117d30fe1)
* [3.11] gh-106909: Use role :const: for referencing module constants ↵Serhiy Storchaka2023-07-211-1/+1
| | | | | (GH-106910) (GH-106957) (cherry picked from commit 4b9948617f91175783609769aa6160e5b49b9ccc)
* [3.11] gh-106892: Use roles :data: and :const: for referencing module ↵Serhiy Storchaka2023-07-211-3/+3
| | | | | variables (GH-106894) (GH-106955) (cherry picked from commit d036db728ea3d54509cbad06df74e2d9a31fbec8)
* [3.11] gh-106919: Use role :c:macro: for referencing the C "constants" ↵Serhiy Storchaka2023-07-2120-183/+201
| | | | | (GH-106920) (GH-106952) (cherry picked from commit fcc816dbff7ca66c26f57a506e4d2330fe41d0ff)
generated by cgit v0.12 at 2025-09-10 08:19:29 (GMT)