]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add note about usage of STRINGLIB_EMPTY.
authorGeorg Brandl <georg@python.org>
Sun, 17 Jan 2010 12:14:42 +0000 (12:14 +0000)
committerGeorg Brandl <georg@python.org>
Sun, 17 Jan 2010 12:14:42 +0000 (12:14 +0000)
Objects/stringlib/README.txt

index c884ec3c2fdd14def063659baf5bb38bc2301eb3..ab506d60f94bbaa49dc8770ad4c78dbc4a42c855 100644 (file)
@@ -13,7 +13,8 @@ STRINGLIB_CHAR
 
 STRINGLIB_EMPTY
 
-    a PyObject representing the empty string
+    a PyObject representing the empty string, only to be used if
+    STRINGLIB_MUTABLE is 0
 
 Py_ssize_t STRINGLIB_LEN(PyObject*)
 
@@ -31,9 +32,9 @@ STRINGLIB_CHAR* STRINGLIB_STR(PyObject*)
 
 int STRINGLIB_CHECK_EXACT(PyObject *)
 
-    returns true if the object is an instance of our type, not a subclass.
+    returns true if the object is an instance of our type, not a subclass
 
 STRINGLIB_MUTABLE
 
-    Must be 0 or 1 to tell the cpp macros in stringlib code if the object
-    being operated on is mutable or not.
+    must be 0 or 1 to tell the cpp macros in stringlib code if the object
+    being operated on is mutable or not