]> granicus.if.org Git - python/commitdiff
Issue #4129: More documentation pointers about int -> Py_ssize_t.
authorJeroen Ruigrok van der Werven <asmodai@in-nomine.org>
Sat, 25 Apr 2009 19:44:55 +0000 (19:44 +0000)
committerJeroen Ruigrok van der Werven <asmodai@in-nomine.org>
Sat, 25 Apr 2009 19:44:55 +0000 (19:44 +0000)
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().

Doc/c-api/gcsupport.rst

index cc5fd5c546809ec23a4125d92f277815905d6036..7fe33b3b6091a44995a0a67e42d8ca70c4f85696 100644 (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)