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.2.1c1~507
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=32a3587345f3207c4471b7eca88be9fbb0cbc65c;p=python

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

diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 6c6e6f52a2..a476e3740b 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -463,7 +463,8 @@ parameter and are called with a non-string parameter.
 
 \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,