https://github.com/python/cpython/commit/4821f08674e290a396d27aa8256fd5b8a121f3d6
commit: 4821f08674e290a396d27aa8256fd5b8a121f3d6
branch: main
author: Nikita Sobolev <[email protected]>
committer: hugovk <[email protected]>
date: 2024-02-10T15:59:23-07:00
summary:
gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (#114786)
files:
M Doc/c-api/gcsupport.rst
M Doc/tools/.nitignore
M Misc/NEWS.d/3.12.0b1.rst
diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst
index 6b2494ee4f0ed4..621da3eb069949 100644
--- a/Doc/c-api/gcsupport.rst
+++ b/Doc/c-api/gcsupport.rst
@@ -83,10 +83,15 @@ rules:
.. versionadded:: 3.12
-.. c:function:: TYPE* PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t
newsize)
+.. c:macro:: PyObject_GC_Resize(TYPE, op, newsize)
- Resize an object allocated by :c:macro:`PyObject_NewVar`. Returns the
- resized object or ``NULL`` on failure. *op* must not be tracked by the
collector yet.
+ Resize an object allocated by :c:macro:`PyObject_NewVar`.
+ Returns the resized object of type ``TYPE*`` (refers to any C type)
+ or ``NULL`` on failure.
+
+ *op* must be of type :c:expr:`PyVarObject *`
+ and must not be tracked by the collector yet.
+ *newsize* must be of type :c:type:`Py_ssize_t`.
.. c:function:: void PyObject_GC_Track(PyObject *op)
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 9db02c5c3c73c9..1d1b16166e906c 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -5,7 +5,6 @@
Doc/c-api/descriptor.rst
Doc/c-api/exceptions.rst
Doc/c-api/float.rst
-Doc/c-api/gcsupport.rst
Doc/c-api/init.rst
Doc/c-api/init_config.rst
Doc/c-api/intro.rst
diff --git a/Misc/NEWS.d/3.12.0b1.rst b/Misc/NEWS.d/3.12.0b1.rst
index 211513d05d0040..21f2c748f40548 100644
--- a/Misc/NEWS.d/3.12.0b1.rst
+++ b/Misc/NEWS.d/3.12.0b1.rst
@@ -2371,7 +2371,7 @@ Add a new C-API function to eagerly assign a version tag
to a PyTypeObject:
.. nonce: _paFIF
.. section: C API
-:c:func:`PyObject_GC_Resize` should calculate preheader size if needed.
+:c:macro:`PyObject_GC_Resize` should calculate preheader size if needed.
Patch by Donghee Na.
..
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
