From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 13 Feb 2024 21:25:54 +0000 (+0100)
Subject: [3.12] gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (GH-114786) (#115263)
X-Git-Tag: v3.12.3~286
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=45e55991305ed9dde0d258312a18fd9d9c4f0426;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (GH-114786) (#115263)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
---

diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst
index 6b2494ee4f0e..621da3eb0699 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 36921864700e..8a0b0b558eb5 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -5,7 +5,6 @@
 Doc/c-api/arg.rst
 Doc/c-api/descriptor.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 c850608b8ca7..3c1f61c6c65d 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.
 
 ..