https://github.com/python/cpython/commit/cb941e126407d6f92de5177c6be456540cd84d3c commit: cb941e126407d6f92de5177c6be456540cd84d3c branch: 3.11 author: Hugo van Kemenade <[email protected]> committer: hugovk <[email protected]> date: 2024-02-14T16:32:58+02:00 summary:
[3.11] gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (GH-114786) (#115430) Co-authored-by: Nikita Sobolev <[email protected]> files: M Doc/c-api/gcsupport.rst M Doc/tools/.nitignore diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 6bdbb008f8e74a..c147e6dc23fbcb 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -64,10 +64,15 @@ rules: :c:macro:`Py_TPFLAGS_HAVE_GC` flag set. -.. 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 9e64e2424c0d48..5aad36e533790b 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -4,7 +4,6 @@ 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 _______________________________________________ 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]
