From: Fred Drake <fdrake@acm.org>
Date: Thu, 6 Dec 2001 20:38:15 +0000 (+0000)
Subject: Document that PyString_FromString() cannot take NULL as a parameter.
X-Git-Tag: v2.1.2c1~52
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=33f9fa7f8c423e59db3137830f4b5aba5e7a3da2;p=thirdparty%2FPython%2Fcpython.git

Document that PyString_FromString() cannot take NULL as a parameter.
This closes SF bug #489872.
---

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 6d8171d26732..e3ba0d2add03 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -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,