Skip to content

Commit

Permalink
pythongh-110383: Improve accuracy of str.split() and str.rsplit() doc…
Browse files Browse the repository at this point in the history
…strings (python#113355)

Clarify split direction in the docstring body,
instead of in the 'maxsplit' param docstring.
  • Loading branch information
erlend-aasland authored and ryan-duve committed Dec 26, 2023
1 parent cc55511 commit e61da02
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
8 changes: 5 additions & 3 deletions Objects/clinic/unicodeobject.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions Objects/unicodeobject.c
Expand Up @@ -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.
Expand All @@ -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);
Expand Down

0 comments on commit e61da02

Please sign in to comment.