8000 [3.11] gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (GH-11… · hugovk/cpython@d9601a3 · GitHub
[go: up one dir, main page]
Skip to content

Commit d9601a3

Browse files
sobolevnhugovk
sobolevn
authored and
hugovk
committed
[3.11] pythongh-101100: Fix sphinx warnings in c-api/gcsupport.rst (pythonGH-114786)
(cherry picked from commit 4821f08) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
1 parent 0af16e3 commit d9601a3

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

‎Doc/c-api/gcsupport.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,15 @@ rules:
6464
:c:macro:`Py_TPFLAGS_HAVE_GC` flag set.
6565

6666

67-
.. c:function:: TYPE* PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t newsize)
67+
.. c:macro:: PyObject_GC_Resize(TYPE, op, newsize)
6868
69-
Resize an object allocated by :c:macro:`PyObject_NewVar`. Returns the
70-
resized object or ``NULL`` on failure. *op* must not be tracked by the collector yet.
69+
Resize an object allocated by :c:macro:`PyObject_NewVar`.
70+
Returns the resized object of type ``TYPE*`` (refers to any C type)
71+
or ``NULL`` on failure.
72+
73+
*op* must be of type :c:expr:`PyVarObject *`
74+
and must not be tracked by the collector yet.
75+
*newsize* must be of type :c:type:`Py_ssize_t`.
7176

7277

7378
.. c:function:: void PyObject_GC_Track(PyObject *op)

‎Doc/tools/.nitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
Doc/c-api/descriptor.rst
66
Doc/c-api/float.rst
7-
Doc/c-api/gcsupport.rst
87
Doc/c-api/init.rst
98
Doc/c-api/init_config.rst
109
Doc/c-api/intro.rst

0 commit comments

Comments
 (0)
0