From: Jeroen Ruigrok van der Werven <asmodai@in-nomine.org>
Date: Sat, 25 Apr 2009 20:55:39 +0000 (+0000)
Subject: Issue #4129: more int -> Py_ssize_t documentation.
X-Git-Tag: v2.7a1~1383
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7b3750c8d896a1f8478868d3e442748143b0b317;p=python

Issue #4129: more int -> Py_ssize_t documentation.
---

diff --git a/Doc/c-api/string.rst b/Doc/c-api/string.rst
index 359b4c57b9..c7d27a31c7 100644
--- a/Doc/c-api/string.rst
+++ b/Doc/c-api/string.rst
@@ -147,6 +147,10 @@ called with a non-string parameter.
 
    Macro form of :cfunc:`PyString_Size` but without error checking.
 
+   .. versionchanged:: 2.5
+      This macro returned an :ctype:`int` type. This might require changes in
+      your code for properly supporting 64-bit systems.
+
 
 .. cfunction:: char* PyString_AsString(PyObject *string)
 
@@ -182,6 +186,10 @@ called with a non-string parameter.
    *string* and operates on that.  If *string* is not a string object at all,
    :cfunc:`PyString_AsStringAndSize` returns ``-1`` and raises :exc:`TypeError`.
 
+   .. versionchanged:: 2.5
+      This function used an :ctype:`int *` type for *length*. This might
+      require changes in your code for properly supporting 64-bit systems.
+
 
 .. cfunction:: void PyString_Concat(PyObject **string, PyObject *newpart)
 
@@ -261,6 +269,10 @@ called with a non-string parameter.
 
       This function is not available in 3.x and does not have a PyBytes alias.
 
+   .. 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:: PyObject* PyString_AsDecodedObject(PyObject *str, const char *encoding, const char *errors)
 
@@ -287,6 +299,10 @@ called with a non-string parameter.
 
       This function is not available in 3.x and does not have a PyBytes alias.
 
+   .. 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:: PyObject* PyString_AsEncodedObject(PyObject *str, const char *encoding, const char *errors)