From: Raymond Hettinger <python@rcn.com>
Date: Fri, 10 Dec 2004 17:13:51 +0000 (+0000)
Subject: SF bug #1082944:  Incorrect docs for PyUnicode_TailMatch
X-Git-Tag: v2.4.1c1~169
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e0c80c33af2f5a3f6112f9d4dd24b636759f5d85;p=thirdparty%2FPython%2Fcpython.git

SF bug #1082944:  Incorrect docs for PyUnicode_TailMatch

* Note correct return type is int.
* Note that -1 returned on failure.
---

diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 001d0ad21441..111725fc7ae6 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -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,