mirror of
https://github.com/python/cpython
synced 2024-09-05 08:17:45 +00:00
bpo-29549: Fixes docstring for str.index (#256)
* Updates B.index documentation. * Updates str.index documentation, makes it Argument Clinic compatible. * Removes ArgumentClinic code. * Finishes string.index documentation. * Updates string.rindex documentation. * Documents B.rindex.
This commit is contained in:
parent
257b980b31
commit
43ba8861e0
|
@ -546,7 +546,11 @@ _Py_bytes_find(const char *str, Py_ssize_t len, PyObject *args)
|
|||
PyDoc_STRVAR_shared(_Py_index__doc__,
|
||||
"B.index(sub[, start[, end]]) -> int\n\
|
||||
\n\
|
||||
Like B.find() but raise ValueError when the subsection is not found.");
|
||||
Return the lowest index in B where subsection sub is found,\n\
|
||||
such that sub is contained within B[start,end]. Optional\n\
|
||||
arguments start and end are interpreted as in slice notation.\n\
|
||||
\n\
|
||||
Raises ValueError when the subsection is not found.");
|
||||
|
||||
PyObject *
|
||||
_Py_bytes_index(const char *str, Py_ssize_t len, PyObject *args)
|
||||
|
@ -583,7 +587,11 @@ _Py_bytes_rfind(const char *str, Py_ssize_t len, PyObject *args)
|
|||
PyDoc_STRVAR_shared(_Py_rindex__doc__,
|
||||
"B.rindex(sub[, start[, end]]) -> int\n\
|
||||
\n\
|
||||
Like B.rfind() but raise ValueError when the subsection is not found.");
|
||||
Return the highest index in B where subsection sub is found,\n\
|
||||
such that sub is contained within B[start,end]. Optional\n\
|
||||
arguments start and end are interpreted as in slice notation.\n\
|
||||
\n\
|
||||
Raise ValueError when the subsection is not found.");
|
||||
|
||||
PyObject *
|
||||
_Py_bytes_rindex(const char *str, Py_ssize_t len, PyObject *args)
|
||||
|
@ -815,4 +823,3 @@ PyDoc_STRVAR_shared(_Py_zfill__doc__,
|
|||
"\n"
|
||||
"Pad a numeric string B with zeros on the left, to fill a field\n"
|
||||
"of the specified width. B is never truncated.");
|
||||
|
||||
|
|
|
@ -11697,7 +11697,11 @@ unicode_hash(PyObject *self)
|
|||
PyDoc_STRVAR(index__doc__,
|
||||
"S.index(sub[, start[, end]]) -> int\n\
|
||||
\n\
|
||||
Like S.find() but raise ValueError when the substring is not found.");
|
||||
Return the lowest index in S where substring sub is found, \n\
|
||||
such that sub is contained within S[start:end]. Optional\n\
|
||||
arguments start and end are interpreted as in slice notation.\n\
|
||||
\n\
|
||||
Raises ValueError when the substring is not found.");
|
||||
|
||||
static PyObject *
|
||||
unicode_index(PyObject *self, PyObject *args)
|
||||
|
@ -12813,7 +12817,11 @@ unicode_rfind(PyObject *self, PyObject *args)
|
|||
PyDoc_STRVAR(rindex__doc__,
|
||||
"S.rindex(sub[, start[, end]]) -> int\n\
|
||||
\n\
|
||||
Like S.rfind() but raise ValueError when the substring is not found.");
|
||||
Return the highest index in S where substring sub is found,\n\
|
||||
such that sub is contained within S[start:end]. Optional\n\
|
||||
arguments start and end are interpreted as in slice notation.\n\
|
||||
\n\
|
||||
Raises ValueError when the substring is not found.");
|
||||
|
||||
static PyObject *
|
||||
unicode_rindex(PyObject *self, PyObject *args)
|
||||
|
|
Loading…
Reference in a new issue