]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Document that PyString_FromString() cannot take NULL as a parameter.
authorFred Drake <fdrake@acm.org>
Thu, 6 Dec 2001 20:38:15 +0000 (20:38 +0000)
committerFred Drake <fdrake@acm.org>
Thu, 6 Dec 2001 20:38:15 +0000 (20:38 +0000)
This closes SF bug #489872.

Doc/api/api.tex

index 6d8171d26732c9991536dfcf1f102d56b965248b..e3ba0d2add03fd373140bbe8bc23b25962c5ce2a 100644 (file)
@@ -2457,7 +2457,8 @@ Returns true if the object \var{o} is a string object.
 
 \begin{cfuncdesc}{PyObject*}{PyString_FromString}{const char *v}
 Returns a new string object with the value \var{v} on success, and
-\NULL{} on failure.
+\NULL{} on failure.  The parameter \var{v} must not be \NULL; it
+will not be checked.
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{PyObject*}{PyString_FromStringAndSize}{const char *v,