mirror of
https://github.com/python/cpython.git
synced 2025-08-24 02:35:59 +00:00
gh-110383: Improve accuracy of str.split() and str.rsplit() docstrings (#113355)
Clarify split direction in the docstring body, instead of in the 'maxsplit' param docstring.
This commit is contained in:
parent
ca8b1d0958
commit
526d0a9b6e
2 changed files with 9 additions and 5 deletions
|
@ -12504,11 +12504,13 @@ str.split as unicode_split
|
|||
character (including \n \r \t \f and spaces) and will discard
|
||||
empty strings from the result.
|
||||
maxsplit: Py_ssize_t = -1
|
||||
Maximum number of splits (starting from the left).
|
||||
Maximum number of splits.
|
||||
-1 (the default value) means no limit.
|
||||
|
||||
Return a list of the substrings in the string, using sep as the separator string.
|
||||
|
||||
Splitting starts at the front of the string and works to the end.
|
||||
|
||||
Note, str.split() is mainly useful for data that has been intentionally
|
||||
delimited. With natural text that includes punctuation, consider using
|
||||
the regular expression module.
|
||||
|
@ -12517,7 +12519,7 @@ the regular expression module.
|
|||
|
||||
static PyObject *
|
||||
unicode_split_impl(PyObject *self, PyObject *sep, Py_ssize_t maxsplit)
|
||||
/*[clinic end generated code: output=3a65b1db356948dc input=07b9040d98c5fe8d]*/
|
||||
/*[clinic end generated code: output=3a65b1db356948dc input=a29bcc0c7a5af0eb]*/
|
||||
{
|
||||
if (sep == Py_None)
|
||||
return split(self, NULL, maxsplit);
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue