diff options
author | Georg Brandl <georg@python.org> | 2006-08-14 12:36:06 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2006-08-14 12:36:06 (GMT) |
commit | 4873fb2bacb0bd34c38302d8969e5cc418d9f99e (patch) | |
tree | bf89959e8c85c3e273d8c66886c96a8d0c0d33c1 /Doc/api | |
parent | 757ea27b0f618ec84e365edf067cc5e52e11947f (diff) | |
download | cpython-4873fb2bacb0bd34c38302d8969e5cc418d9f99e.zip cpython-4873fb2bacb0bd34c38302d8969e5cc418d9f99e.tar.gz cpython-4873fb2bacb0bd34c38302d8969e5cc418d9f99e.tar.bz2 |
Improve markup in PyUnicode_RichCompare.
Diffstat (limited to 'Doc/api')
-rw-r--r-- | Doc/api/concrete.tex | 33 |
1 files changed, 14 insertions, 19 deletions
diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex index cd9d8d5..91fd3bb 100644 --- a/Doc/api/concrete.tex +++ b/Doc/api/concrete.tex @@ -1564,25 +1564,20 @@ They all return \NULL{} or \code{-1} if an exception occurs. PyObject *right, int op} -% This entry could use some polishing - my TeX is too -% rusty these days... (MAL) - - Rich compare two strings and return one of the following: -\begin{verbatim} - - NULL in case an exception was raised - - Py_True or Py_False for successfuly comparisons - - Py_NotImplemented in case the type combination is unknown -\end{verbatim} - - Note that Py_EQ and Py_NE comparisons can cause a UnicodeWarning in - case the conversion of the arguments to Unicode fails with a - UnicodeDecodeError. - - Possible values for \var{op}: -\begin{verbatim} - Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE -\end{verbatim} - + Rich compare two unicode strings and return one of the following: + \begin{itemize} + \item \code{NULL} in case an exception was raised + \item \constant{Py_True} or \constant{Py_False} for successful comparisons + \item \constant{Py_NotImplemented} in case the type combination is unknown + \end{itemize} + + Note that \constant{Py_EQ} and \constant{Py_NE} comparisons can cause a + \exception{UnicodeWarning} in case the conversion of the arguments to + Unicode fails with a \exception{UnicodeDecodeError}. + + Possible values for \var{op} are + \constant{Py_GT}, \constant{Py_GE}, \constant{Py_EQ}, + \constant{Py_NE}, \constant{Py_LT}, and \constant{Py_LE}. \end{cfuncdesc} \begin{cfuncdesc}{PyObject*}{PyUnicode_Format}{PyObject *format, |