mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-31 07:04:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Issue #4129: More documentation pointers about int -> Py_ssize_t.

Browse source 
Also fix up the documentation for PyObject_GC_Resize(). It seems that since
it first got documented, the documentation was actually for
_PyObject_GC_Resize().
This commit is contained in:
Jeroen Ruigrok van der Werven 2009-04-25 19:44:55 +00:00
parent 3537124058
commit 691f5f17ee
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/c-api/gcsupport.rst
View file

@ -48,12 +48,20 @@ Constructors for container types must conform to two rules:
Analogous to :cfunc:`PyObject_NewVar` but for container objects with the
:const:`Py_TPFLAGS_HAVE_GC` flag set.
.. versionchanged:: 2.5
This function used an :ctype:`int` type for *size*. This might require
changes in your code for properly supporting 64-bit systems.
.. cfunction:: PyVarObject * PyObject_GC_Resize(PyVarObject *op, Py_ssize_t)
.. cfunction:: TYPE* PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t newsize)
Resize an object allocated by :cfunc:`PyObject_NewVar`. Returns the
resized object or *NULL* on failure.
.. versionchanged:: 2.5
This function used an :ctype:`int` type for *newsize*. This might
require changes in your code for properly supporting 64-bit systems.
.. cfunction:: void PyObject_GC_Track(PyObject *op)