summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@haypocalc.com>2010-12-28 23:39:51 (GMT)
committerVictor Stinner <victor.stinner@haypocalc.com>2010-12-28 23:39:51 (GMT)
commit80e788a5ddddc2d4a01f25e8021534e4d6239d39 (patch)
tree295f4f71c38f22c10dfdf1fd28fefa566445a6ee /Doc
parentece98d6e086e3a901c948d49fad4f92f0de17523 (diff)
downloadcpython-80e788a5ddddc2d4a01f25e8021534e4d6239d39.zip
cpython-80e788a5ddddc2d4a01f25e8021534e4d6239d39.tar.gz
cpython-80e788a5ddddc2d4a01f25e8021534e4d6239d39.tar.bz2
Rephrase PyUnicode_CompareWithASCIIString() documentation
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/unicode.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index fd36356..6783f65 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -1063,8 +1063,9 @@ They all return *NULL* or ``-1`` if an exception occurs.
.. c:function:: int PyUnicode_CompareWithASCIIString(PyObject *uni, char *string)
Compare a unicode object, *uni*, with *string* and return -1, 0, 1 for less
- than, equal, and greater than, respectively. *string* is an ASCII-encoded
- string (it is interpreted as ISO-8859-1).
+ than, equal, and greater than, respectively. It is best to pass only
+ ASCII-encoded strings, but the function interprets the input string as
+ ISO-8859-1 if it contains non-ASCII characters".
.. c:function:: int PyUnicode_RichCompare(PyObject *left, PyObject *right, int op)