diff options
| author | Nikita Sobolev <mail@sobolevn.me> | 2024-02-10 22:59:23 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-10 22:59:23 (GMT) |
| commit | 4821f08674e290a396d27aa8256fd5b8a121f3d6 (patch) | |
| tree | c7548b275bdae6584ca86c35776695c338c53bdf /Doc | |
| parent | b70a68fbd6b72a25b5ef430603e39c9e40f40d29 (diff) | |
| download | cpython-4821f08674e290a396d27aa8256fd5b8a121f3d6.zip cpython-4821f08674e290a396d27aa8256fd5b8a121f3d6.tar.gz cpython-4821f08674e290a396d27aa8256fd5b8a121f3d6.tar.bz2 | |
gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (#114786)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/c-api/gcsupport.rst | 11 | ||||
| -rw-r--r-- | Doc/tools/.nitignore | 1 |
2 files changed, 8 insertions, 4 deletions
diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 6b2494e..621da3e 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 9db02c5..1d1b161 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 |