SF bug #1082944: Incorrect docs for PyUnicode_TailMatch
authorRaymond Hettinger <python@rcn.com>
Fri, 10 Dec 2004 17:12:32 +0000 (17:12 +0000)
committerRaymond Hettinger <python@rcn.com>
Fri, 10 Dec 2004 17:12:32 +0000 (17:12 +0000)
* Note correct return type is int.
* Note that -1 returned on failure.

Doc/api/concrete.tex

index 001d0ad214410b0fc4001c7b9804721a6497dd0b..111725fc7ae6ef3f22728b9962b9db1027bf8217 100644 (file)
@@ -1449,7 +1449,7 @@ They all return \NULL{} or \code{-1} if an exception occurs.
   resulting Unicode string.
 \end{cfuncdesc}
 
-\begin{cfuncdesc}{PyObject*}{PyUnicode_Tailmatch}{PyObject *str,
+\begin{cfuncdesc}{int}{PyUnicode_Tailmatch}{PyObject *str,
                                                   PyObject *substr,
                                                   int start,
                                                   int end,
@@ -1457,6 +1457,7 @@ They all return \NULL{} or \code{-1} if an exception occurs.
   Return 1 if \var{substr} matches \var{str}[\var{start}:\var{end}] at
   the given tail end (\var{direction} == -1 means to do a prefix
   match, \var{direction} == 1 a suffix match), 0 otherwise.
+  Returns \code{-1} if an error occurred.                         
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{int}{PyUnicode_Find}{PyObject *str,