summaryrefslogtreecommitdiffstats
path: root/Objects/stringlib
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-01-17 12:14:42 (GMT)
committerGeorg Brandl <georg@python.org>2010-01-17 12:14:42 (GMT)
commitaee900338e76c9d0879bf9470bc3be7912b11817 (patch)
treeb28182d56f4ed3770e1384a3ab994ed14247150c /Objects/stringlib
parentab6ee7a04207cb95140cd7aa52ebe132297c2103 (diff)
downloadcpython-aee900338e76c9d0879bf9470bc3be7912b11817.zip
cpython-aee900338e76c9d0879bf9470bc3be7912b11817.tar.gz
cpython-aee900338e76c9d0879bf9470bc3be7912b11817.tar.bz2
Add note about usage of STRINGLIB_EMPTY.
Diffstat (limited to 'Objects/stringlib')
-rw-r--r--Objects/stringlib/README.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/Objects/stringlib/README.txt b/Objects/stringlib/README.txt
index c884ec3..ab506d6 100644
--- a/Objects/stringlib/README.txt
+++ b/Objects/stringlib/README.txt
@@ -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