sobolevn
5492f84c14
[3.12] gh-121615: Improve module.rst
C-API docs with better error descriptions (GH-121616) ( #121619 )
...
(cherry picked from commit e6264b44dc
)
2024-07-11 09:12:06 +00:00
Miss Islington (bot)
06b2ba3831
[3.12] gh-121567: Improve slice
C-API docs by mentioning exceptions (GH-121568) ( #121579 )
...
gh-121567: Improve `slice` C-API docs by mentioning exceptions (GH-121568)
(cherry picked from commit 84a5597b08
)
Co-authored-by: sobolevn <mail@sobolevn.me>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-07-10 11:03:22 +00:00
Miss Islington (bot)
e1a223431f
[3.12] gh-121533: Improve PyCell_[Get,Set]
docs: mention the exceptions (GH-121534) ( #121540 )
...
gh-121533: Improve `PyCell_[Get,Set]` docs: mention the exceptions (GH-121534)
(cherry picked from commit 649d5b6d7b
)
Co-authored-by: sobolevn <mail@sobolevn.me>
Co-authored-by: Victor Stinner <vstinner@python.org>
2024-07-09 19:03:12 +03:00
Miss Islington (bot)
4ade7723e8
[3.12] docs: Fix "Py_TPFLAGS_MANAGED_WEAKREF is set in tp_flags" (GH-112237) ( #121310 )
...
docs: Fix "Py_TPFLAGS_MANAGED_WEAKREF is set in tp_flags" (GH-112237)
(cherry picked from commit 4232976b02
)
Co-authored-by: da-woods <dw-git@d-woods.co.uk>
2024-07-03 13:50:02 +05:30
Miss Islington (bot)
a57d917a48
[3.12] gh-120838: Add a Note in the Docs About Expectations for Py_Finalize() (gh-120853)
...
(cherry picked from commit 03fa2df927
, AKA gh-120839)
Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
2024-06-21 19:12:08 +00:00
Miss Islington (bot)
8d7e54af0d
[3.12] gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475) ( #119603 )
...
gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475)
(cherry picked from commit 3b26cd8ca0
)
Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
2024-05-27 12:22:23 +00:00
Hugo van Kemenade
7f86c769db
[3.12] docs: fix a few typos identified by codespell (GH-119516) ( #119571 )
...
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-05-26 08:15:57 +00:00
Serhiy Storchaka
530c3bb271
[3.12] Format None, True, False and NotImplemented as literals (GH-118758) (GH-118794)
...
(cherry picked from commit 05c2fe1acd
)
2024-05-08 19:55:13 +00:00
Miss Islington (bot)
f278b8fefc
[3.12] gh-116935: Document that heap types need to support garbage collection (GH-118021) (GH-118092)
...
gh-116935: Document that heap types need to support garbage collection (GH-118021)
(cherry picked from commit 5d54436574
)
Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-04-19 11:44:19 +02:00
Miss Islington (bot)
15be34ade8
[3.12] gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc (GH-117920) ( #118087 )
...
gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc (GH-117920)
(cherry picked from commit 4605a197bd
)
Co-authored-by: Victor Stinner <vstinner@python.org>
2024-04-19 10:57:51 +02:00
Miss Islington (bot)
ac48fdeb0d
[3.12] gh-73231: Update documentation for PyErr_SetFromWindowsErr() (GH-117226) (GH-117973)
...
(cherry picked from commit 438b7c3071
)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-04-17 10:28:55 +00:00
Hugo van Kemenade
eb0bfb5910
[3.12] Docs: add link roles with Sphinx extlinks (GH-117850) ( #117910 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 13:18:21 -06:00
Serhiy Storchaka
1e75fe1468
[3.12] gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298) (GH-116450)
...
(cherry picked from commit 808a77612f
)
2024-03-07 08:21:25 +00:00
Miss Islington (bot)
6e89141d73
[3.12] Fix the PyGetSetDef documentation (GH-116056) (GH-116363)
...
closure is not a function pointer, it is a user data pointer.
(cherry picked from commit df59401108
)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-03-05 16:16:50 +00:00
Miss Islington (bot)
8d0ec39732
[3.12] gh-115653: Document PyCode_GetFirstFree() (GH-115654) ( #115752 )
...
gh-115653: Document PyCode_GetFirstFree() (GH-115654)
Correct the return type of the PyCode_GetNumFree() documentation.
(cherry picked from commit 10fc4675fd
)
Co-authored-by: Bogdan Romanyuk <65823030+wrongnull@users.noreply.github.com>
2024-02-21 11:31:56 +01:00
Miss Islington (bot)
2763f382f9
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst
(GH-115580) ( #115589 )
...
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:18:30 -07:00
Miss Islington (bot)
03d2c3b804
[3.12] gh-113437: Update documentation about PyUnicode_AsWideChar() function (GH-113455) (GH-115407)
...
(cherry picked from commit 5719aa23ab
)
Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
2024-02-14 11:24:40 +01:00
Miss Islington (bot)
45e5599130
[3.12] gh-101100: Fix sphinx warnings in c-api/gcsupport.rst
(GH-114786) ( #115263 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-02-13 14:25:54 -07:00
Miss Islington (bot)
67688609d2
[3.12] gh-101100: Clean up Doc/c-api/exceptions.rst and Doc/c-api/sys.rst (GH-114825) (GH-115308)
...
(cherry picked from commit e1552fd19d
)
Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-02-11 19:02:21 +00:00
Serhiy Storchaka
b9f560258c
[3.12] gh-115172: Fix explicit index extries for the C API (GH-115173) (GH-115292)
...
(cherry picked from commit 573acb30f2
)
2024-02-11 10:34:41 +00:00
Miss Islington (bot)
370cbbbfeb
[3.12] Docs: correctly link to code objects (GH-115214) ( #115216 )
...
(cherry picked from commit 769d444826
)
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-09 14:17:49 +00:00
Miss Islington (bot)
a69e68db60
[3.12] gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003) ( #115135 )
...
gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003)
(cherry picked from commit d0322fdf2c
)
Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-02-07 10:55:21 +00:00
Miss Islington (bot)
d334122d22
[3.12] GH-69695: Update `PyImport_ImportModule
` description (GH-103836) GH-114925)
...
GH-69695: Update ``PyImport_ImportModule`` description (GH-103836)
(cherry picked from commit 9872855a31
)
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>
2024-02-05 10:53:57 +01:00
Miss Islington (bot)
cf2ecbc514
[3.12] gh-101100: Fix sphinx warnings in c-api/file.rst
(GH-114546) ( #114584 )
...
* gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546)
(cherry picked from commit 01d970c1b8
)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-04 10:57:19 +02:00
Miss Islington (bot)
930f805e72
[3.12] gh-101100: Fix sphinx warnings in Doc/c-api/memoryview.rst
(GH-114669) (GH-114704)
...
(cherry picked from commit 97fb2480e4
)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-29 10:02:06 +00:00
Miss Islington (bot)
3bf5d90360
[3.12] gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891) (GH-114638)
...
(cherry picked from commit 926881dc10
)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-27 08:02:15 +00:00
Miss Islington (bot)
c95cdd0a82
[3.12] Document PyOS_strtoul and PyOS_strtol (GH-114048) (GH-114618)
...
(cherry picked from commit 3f62bf32ca
)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-26 17:50:33 +00:00
Miss Islington (bot)
3a588d09d5
[3.12] gh-101100: Fix Sphinx warnings in c-api/structures.rst
(GH-113564) ( #114527 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-01-24 13:48:36 +00:00
Miss Islington (bot)
69f876a82a
[3.12] gh-101100: Fix sphinx warnings in Doc/c-api/memory.rst
(GH-114373) ( #114377 )
...
gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373)
(cherry picked from commit 47133d8d86
)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-21 09:41:00 +00:00
Miss Islington (bot)
f9158d63b1
[3.12] gh-112092: clarify unstable ABI recompilation requirements (GH-112093) ( #114260 )
...
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
)
Co-authored-by: DerSchinken <53398996+DerSchinken@users.noreply.github.com>
2024-01-18 21:28:04 +01:00
Miss Islington (bot)
27941b14ab
[3.12] gh-102468: Document PyCFunction_New*
and PyCMethod_New
(GH-112557) (GH-114119)
...
gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557)
(cherry picked from commit a482bc67ee
)
Co-authored-by: AN Long <aisk@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-01-17 10:21:08 +01:00
Miss Islington (bot)
f3d3663a47
[3.12] gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (GH-113369) ( #113606 )
...
gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (GH-113369)
(cherry picked from commit 2849cbb53a
)
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-12-31 23:22:55 +00:00
Miss Islington (bot)
78ccb41c56
[3.12] docs: specify that PyBytes_AsStringAndSize returns 0 on success (GH-110888) (GH-111690)
...
(cherry picked from commit 9f33ede127
)
Co-authored-by: lefp <70862148+lefp@users.noreply.github.com>
2023-12-25 20:24:22 +02:00
Miss Islington (bot)
34714f4ac9
[3.12] gh-101100: Improve docs on exception attributes (GH-113057) ( #113061 )
...
gh-101100: Improve docs on exception attributes (GH-113057)
(cherry picked from commit d05a180350
)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-13 19:07:19 +00:00
Miss Islington (bot)
e328115254
[3.12] gh-101100: Further improve docs on function attributes (GH-113001) ( #113030 )
...
gh-101100: Further improve docs on function attributes (GH-113001)
(cherry picked from commit 81a15ea74e
)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-12 20:28:10 +00:00
Hugo van Kemenade
54fcfbde30
[3.12] gh-101100: Improve documentation on function attributes (GH-112933) ( #112974 )
...
(cherry picked from commit 4c5b9c107a
)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-12 10:10:27 +00:00
Miss Islington (bot)
c108080626
Doc: c-api: fix order of PyMemberDef fields (GH-112879)
...
Doc: c-api: fix order of PyMemberDef fields (GH-112879)
(cherry picked from commit 42a86df3a3
)
2023-12-10 17:50:05 +00:00
Alex Waygood
ca11aec98c
[3.12] gh-101100: Improve documentation of code object attributes ( #112781 ) ( #112816 )
...
(cherry-picked from commit e9707d3c3d
)
2023-12-06 22:11:53 +00:00
Miss Islington (bot)
399a3f2e1e
[3.12] gh-111178: Docs: fix traverseproc
, inquiry
, and destructor
parameters in slot typedefs table (GH-112742) (GH-112792)
...
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
)
Co-authored-by: Christopher Chavez <chrischavez@gmx.us>
2023-12-06 11:03:22 +01:00
Miss Islington (bot)
ef92e9e666
[3.12] gh-101100: Properly document frame object attributes (GH-112735) ( #112772 )
...
gh-101100: Properly document frame object attributes (GH-112735)
(cherry picked from commit d109f637c0
)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-05 19:34:06 +00:00
Serhiy Storchaka
f1a0c77f4e
[3.12] gh-62897: Update PyUnicode C API parameter names (GH-12680) (GH-112744)
...
Standardize PyUnicode C API parameter names across the documentation.
(cherry picked from commit b31232ddf7
)
Co-authored-by: Rune Tynan <runetynan@gmail.com>
2023-12-05 11:30:44 +02:00
Miss Islington (bot)
494cd508c0
[3.12] gh-112671: Fixing typo in the Macro Docs (GH-112715) (GH-112726)
...
Replace Py_T_STRING_INLINE with Py_T_STRING_INPLACE
(cherry picked from commit a8ce149628
)
Co-authored-by: Amioplk <amir.worms@dauphine.eu>
2023-12-04 20:58:04 +00:00
Hugo van Kemenade
d7a7883326
[3.12] gh-101100: Fix Sphinx reference warnings (GH-112416) ( #112420 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-11-26 05:22:13 -07:00
Miss Islington (bot)
748bc48648
[3.12] gh-108082: C API: Add tests for PyErr_WriteUnraisable() (GH-111455) (GH-111507)
...
Also document the behavior when called with NULL.
(cherry picked from commit bca3305429
)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-10-30 17:36:00 +00:00
Miss Islington (bot)
87123ab545
[3.12] Add a version added note for PY_VECTORCALL_ARGUMENTS_OFFSET (GH-110963) ( #111219 )
...
Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
2023-10-23 16:09:59 +00:00
Miss Islington (bot)
94525a7a4d
[3.12] C-API docs: Clarify the size of arenas (GH-110895) ( #110946 )
...
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
)
Co-authored-by: Mienxiu <82512658+mienxiu@users.noreply.github.com>
2023-10-16 19:03:18 +00:00
Miss Islington (bot)
b4ed73042e
[3.12] gh-110527: Improve PySet_Clear
docs (GH-110528) ( #110928 )
...
gh-110527: Improve `PySet_Clear` docs (GH-110528)
(cherry picked from commit bfc1cd8145
)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-16 13:14:52 +00:00
Miss Islington (bot)
f2e353b9d8
[3.12] gh-110803: Reorganize docs for what PyType_Slot doesn't cover (GH-110813) ( #110823 )
...
gh-110803: Reorganize docs for what PyType_Slot doesn't cover (GH-110813)
* gh-110803: Reorganize docs for what PyType_Slot doesn't cover
- Cover the offset fields first
- Mention the old alternative for MANAGED flags, which is needed
to support older Pythons
- De-emphasize the internal flags: use an inline list.
- Add a note to PyMemberDef saying what to do with it
* Remove an older draft...
(cherry picked from commit 2ab34f0e42
)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-10-13 12:59:55 +00:00
Ezio Melotti
7d5a982609
[3.12] gh-110631: Fix reST indentation (GH-110724) ( #110738 )
...
* Fix wrong indentation in the other dirs.
* Fix more wrong indentation..
(cherry picked from commit 718391f475
)
2023-10-11 23:12:36 +02:00
Alex Waygood
25bf0564c4
[3.12] Fix typos in docs and comments ( #109619 ) ( #109621 )
...
Fix typos in docs and comments (#109619 )
Co-authored-by: Heinz-Alexander Fuetterer <35225576+afuetterer@users.noreply.github.com>
2023-10-02 17:34:49 +00:00