e89f2a0be1
[3.11] gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298) (GH-116450) (GH-116452)
...
(cherry picked from commit 1e75fe1468808a77612f
2024-03-07 08:35:24 +00:00
c67a4b6bdb
[3.11] Fix the PyGetSetDef documentation (GH-116056) (GH-116368)
...
(cherry picked from commit df59401108
2024-03-05 16:26:29 +00:00
b87a443146
[3.11] gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` (GH-115580) ( #115590 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-17 14:51:28 -07:00
cb941e1264
[3.11] gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (GH-114786) ( #115430 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-02-14 16:32:58 +02:00
7f88cb1f28
[3.11] gh-113437: Update documentation about PyUnicode_AsWideChar() function (GH-113455) (GH-115408)
...
(cherry picked from commit 5719aa23ab
2024-02-14 11:24:54 +01:00
07fff60fb2
[3.11] gh-101100: Clean up Doc/c-api/exceptions.rst and Doc/c-api/sys.rst (GH-114825) (GH-115311)
...
(cherry picked from commit e1552fd19d
2024-02-12 12:54:44 +02:00
446a6db5e1
[3.11] gh-115172: Fix explicit index extries for the C API (GH-115173) (GH-115293)
...
(cherry picked from commit 573acb30f2
2024-02-11 10:42:28 +00:00
ff72af8991
[3.11] Docs: correctly link to code objects (GH-115214) ( #115217 )
...
(cherry picked from commit 769d444826
2024-02-09 14:18:01 +00:00
e1e4cf7611
[3.11] gh-101100: Fix Py_DEBUG dangling Sphinx references ( #115003 ) ( #115141 )
...
gh-101100: Fix Py_DEBUG dangling Sphinx references (#115003 )
(cherry picked from commit d0322fdf2c
2024-02-07 17:16:51 +00:00
b3f0108eac
[3.11] GH-69695: Update ``PyImport_ImportModule`` description (GH-103836) (GH-114924)
...
GH-69695: Update ``PyImport_ImportModule`` description (GH-103836)
(cherry picked from commit 9872855a31
2024-02-05 10:53:50 +01:00
9fd8aaab83
[3.11] gh-101100: Fix sphinx warnings in `Doc/c-api/memoryview.rst` (GH-114669) (GH-114705)
...
(cherry picked from commit 97fb2480e4
2024-01-29 10:02:52 +00:00
b323d99ac9
[3.11] Fix `c-api/file.rst` indexes (GH-114608) (GH-114639)
...
(cherry picked from commit 23fb9f0777
2024-01-27 08:52:37 +00:00
a3953cb9af
[3.11] gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891) (GH-114637)
...
(cherry picked from commit 926881dc10
2024-01-27 08:02:34 +00:00
58e4d3b25e
[3.11] Document PyOS_strtoul and PyOS_strtol (GH-114048) (GH-114619)
...
(cherry picked from commit 3f62bf32ca
2024-01-26 17:51:36 +00:00
170bf7951e
[3.11] gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546) ( #114585 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-26 03:02:49 -07:00
274b93a584
[3.11] gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373) ( #114378 )
...
gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373)
(cherry picked from commit 47133d8d86
2024-01-21 09:40:43 +00:00
ac4c6efc70
[3.11] gh-112092: clarify unstable ABI recompilation requirements (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 68a7b78cd5
2024-01-18 21:28:34 +01:00
bda62c0b22
[3.11] gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557) (GH-114120)
...
gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557)
(cherry picked from commit a482bc67ee
2024-01-17 10:21:16 +01:00
bc6528ee6b
[3.11] docs: specify that PyBytes_AsStringAndSize returns 0 on success (GH-110888) (GH-111691)
...
(cherry picked from commit 9f33ede127
2023-12-25 20:24:44 +02:00
9b3447ca3c
[3.11] gh-101100: Improve docs on exception attributes (GH-113057) ( #113062 )
...
gh-101100: Improve docs on exception attributes (GH-113057)
(cherry picked from commit d05a180350
2023-12-13 19:07:19 +00:00
b8a6eeec39
[3.11] gh-101100: Further improve docs on function attributes ( #113001 ) ( #113031 )
...
(cherry-picked from commit 81a15ea74e
2023-12-12 20:36:51 +00:00
f83087ce03
[3.11] gh-101100: Improve documentation on function attributes ( #112933 ) ( #113003 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-12 14:19:02 +02:00
5fa2d24002
[3.11] gh-101100: Improve documentation of code object attributes ( #112781 ) ( #112817 )
...
(cherry-picked from commit e9707d3c3d
2023-12-06 22:23:20 +00:00
8be7282f29
[3.11] gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` 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 00cce0fe49
2023-12-06 11:03:36 +01:00
c26d6c1aba
[3.11] gh-101100: Properly document frame object attributes ( #112735 ) ( #112775 )
...
* [3.11] gh-101100: Properly document frame object attributes (#112735 )
(cherry-picked from commit d109f637c0
2023-12-05 20:23:25 +00:00
8a51f6d165
[3.11] gh-62897: Update PyUnicode C API parameter names (GH-12680) (GH-112745)
...
Standardize PyUnicode C API parameter names across the documentation.
(cherry picked from commit b31232ddf7
2023-12-05 09:35:36 +00:00
fc657d0c60
[3.11] gh-101100: Fix Sphinx reference warnings (GH-112416) ( #112422 )
2023-11-26 05:22:17 -07:00
09bd752d94
[3.11] Add a version added note for PY_VECTORCALL_ARGUMENTS_OFFSET (GH-110963) ( #111220 )
...
Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
2023-10-23 16:09:56 +00:00
e8eb2bf788
[3.11] C-API docs: Clarify the size of arenas (GH-110895) ( #110947 )
...
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 f07ca27709
2023-10-16 19:06:34 +00:00
616862d58e
[3.11] gh-110527: Improve `PySet_Clear` docs (GH-110528) ( #110927 )
...
gh-110527: Improve `PySet_Clear` docs (GH-110528)
(cherry picked from commit bfc1cd8145
2023-10-16 13:15:07 +00:00
90b2620b6e
[3.11] gh-110631: Fix reST indentation (GH-110724) ( #110739 )
...
* Fix wrong indentation in the other dirs.
* Fix more wrong indentation..
(cherry picked from commit 718391f475
2023-10-11 23:12:53 +02:00
d81bcc2327
[3.11] gh-102304: Add links to the Stable ABI and Limited C API docs ( #105345 ) ( #105371 ) ( #109901 )
...
* Add "limited-c-api" and "stable-api" targets
* Rename the "stable-abi-list" target to "limited-api-list"
2023-09-29 11:17:44 +02:00
d951aaea97
[3.11] gh-107298: Document PyMODINIT_FUNC macro ( #109236 ) ( #109948 )
...
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 d7a27e527d
2023-09-27 10:40:24 +02:00
6538bcfa0b
[3.11] Improve some C API documentation (GH-108768) (GH-108786)
...
* 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 6f97eeec22
2023-09-02 07:30:32 +03:00
cc81f5b61a
[3.11] [3.12] gh-108314: PyDict_GetItemString() mentions UTF-8 (GH-108448) ( #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 9a225d7d5b
2023-08-25 18:48:25 +02:00
3ca9264aba
[3.11] gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258) ( #108290 )
...
(cherry picked from commit d7202e4879
2023-08-22 20:33:07 +02:00
80c7ae00f1
[3.11] gh-107298: Fix C API datetime documentation (GH-108034) ( #108233 )
...
(cherry picked from commit d63972e289
2023-08-22 20:32:48 +02:00
358b1acc69
[3.11] gh-107298: Fix some references in the C API documentation (GH-108072) (GH-108076)
...
(cherry picked from commit f51f0466c0
2023-08-17 08:30:47 +00:00
4e5dac1fe1
[3.11] gh-107298: Fix C API Buffer documentation (GH-108011) ( #108041 )
...
gh-107298: Fix C API Buffer documentation (GH-108011)
(cherry picked from commit c2941cba7a
2023-08-16 22:32:17 +02:00
4ddfb04260
[3.11] Docs: Document PyBUF_MAX_NDIM (GH-107865) ( #107872 )
...
(cherry picked from commit 637f7ff2c6
2023-08-11 16:13:53 +00:00
951320e4d0
[3.11] gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107753)
...
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.
2023-08-07 16:17:12 -06:00
ff5dd9d9db
[3.11] Fix the documentation for PyCode_New add qualname parameter (GH-107186) ( #107454 )
...
[3.11] Fix the documentation for PyCode_New add `qualname` parameter (GH-107186).
(cherry picked from commit f2abeb590d
2023-07-30 08:48:01 +00:00
3c1bcae075
[3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107418)
...
(cherry picked from commit f2d07d3289
2023-07-29 09:17:20 +03:00
d9392c0c0a
[3.11] gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) (GH-107381)
...
(cherry picked from commit 983305268e
2023-07-28 08:31:49 +00:00
32e17d4a3c
[3.11] gh-107298: Fix more Sphinx warnings in the C API doc (GH-107329) (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 8d61a71f9c
2023-07-28 07:03:47 +00:00
dcfdfa5399
[3.11] gh-107298: Fix Sphinx warnings in the C API doc (GH-107302) (GH-107373)
...
(cherry picked from commit 391e03fa05
2023-07-28 06:44:54 +00:00
50d26138e6
[3.11] gh-107298: Fix doc references to undocumented modules (GH-107300) (GH-107371)
...
(cherry picked from commit 87b39028e5
2023-07-28 09:21:50 +03:00
9513acf737
[3.11] gh-107298: Docs: add targets for some :c:member: and :c:macro: 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 abec9a1b20
2023-07-27 09:27:02 +03:00
17aada0dd0
[3.11] gh-107091: Fix some uses of :attr: role (GH-107318) (GH-107331)
...
Fix also formatting of PyMethodDef members.
(cherry picked from commit d363eb5b02
2023-07-27 09:26:14 +03:00
603c5d50e8
[3.11] gh-107091: Fix some uses of :c:type: role (GH-107138) (GH-107313)
...
(cherry picked from commit 6d5b6e71c8
2023-07-27 00:00:36 +03:00
Serhiy Storchaka