Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.11] gh-110383: Improve accuracy of str.split() and str.rsplit() docstrings (GH-113355) #113380

Merged
merged 1 commit into from
Dec 22, 2023
Merged

[3.11] gh-110383: Improve accuracy of str.split() and str.rsplit() docstrings (GH-113355) #113380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Objects/clinic/unicodeobject.c.h
View file
Open in desktop

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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13170,11 +13170,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 @@ -13183,7 +13185,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