Corrected return type and value information for PyUnicode_Count() and

PyUnicode_Find().
This closes SF bug #566631.
This commit is contained in:
Fred Drake 2002-06-20 22:07:04 +00:00
parent ba3ff1ba7b
commit 1d1e1dba12
2 changed files with 18 additions and 14 deletions

View File

@ -1325,23 +1325,27 @@ They all return \NULL{} or \code{-1} if an exception occurs.
match, \var{direction} == 1 a suffix match), 0 otherwise. match, \var{direction} == 1 a suffix match), 0 otherwise.
\end{cfuncdesc} \end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyUnicode_Find}{PyObject *str, \begin{cfuncdesc}{int}{PyUnicode_Find}{PyObject *str,
PyObject *substr, PyObject *substr,
int start, int start,
int end, int end,
int direction} int direction}
Return the first position of \var{substr} in Return the first position of \var{substr} in
\var{str}[\var{start}:\var{end}] using the given \var{direction} \var{str}[\var{start}:\var{end}] using the given \var{direction}
(\var{direction} == 1 means to do a forward search, (\var{direction} == 1 means to do a forward search,
\var{direction} == -1 a backward search), 0 otherwise. \var{direction} == -1 a backward search). The return value is the
index of the first match; a value of \code{-1} indicates that no
match was found, and \code{-2} indicates that an error occurred and
an exception has been set.
\end{cfuncdesc} \end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyUnicode_Count}{PyObject *str, \begin{cfuncdesc}{int}{PyUnicode_Count}{PyObject *str,
PyObject *substr, PyObject *substr,
int start, int start,
int end} int end}
Count the number of occurrences of \var{substr} in Return the number of non-overlapping occurrences of \var{substr} in
\var{str}[\var{start}:\var{end}] \code{\var{str}[\var{start}:\var{end}]}. Returns \code{-1} if an
error occurred.
\end{cfuncdesc} \end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyUnicode_Replace}{PyObject *str, \begin{cfuncdesc}{PyObject*}{PyUnicode_Replace}{PyObject *str,

View File

@ -1393,14 +1393,14 @@ PyUnicode_Tailmatch:int:start::
PyUnicode_Tailmatch:int:end:: PyUnicode_Tailmatch:int:end::
PyUnicode_Tailmatch:int:direction:: PyUnicode_Tailmatch:int:direction::
PyUnicode_Find:PyObject*::+1: PyUnicode_Find:int:::
PyUnicode_Find:PyObject*:str:0: PyUnicode_Find:PyObject*:str:0:
PyUnicode_Find:PyObject*:substr:0: PyUnicode_Find:PyObject*:substr:0:
PyUnicode_Find:int:start:: PyUnicode_Find:int:start::
PyUnicode_Find:int:end:: PyUnicode_Find:int:end::
PyUnicode_Find:int:direction:: PyUnicode_Find:int:direction::
PyUnicode_Count:PyObject*::+1: PyUnicode_Count:int:::
PyUnicode_Count:PyObject*:str:0: PyUnicode_Count:PyObject*:str:0:
PyUnicode_Count:PyObject*:substr:0: PyUnicode_Count:PyObject*:substr:0:
PyUnicode_Count:int:start:: PyUnicode_Count:int:start::