Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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:
Erlend E. Aasland 2023-12-21 15:22:39 +01:00 committed by GitHub
parent ca8b1d0958
commit 526d0a9b6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Objects/clinic/unicodeobject.c.h generated
View File

@ -954,9 +954,11 @@ PyDoc_STRVAR(unicode_split__doc__,
" character (including \\n \\r \\t \\f and spaces) and will discard\n" " character (including \\n \\r \\t \\f and spaces) and will discard\n"
" empty strings from the result.\n" " empty strings from the result.\n"
" maxsplit\n" " maxsplit\n"
" Maximum number of splits (starting from the left).\n" " Maximum number of splits.\n"
" -1 (the default value) means no limit.\n" " -1 (the default value) means no limit.\n"
"\n" "\n"
"Splitting starts at the front of the string and works to the end.\n"
"\n"
"Note, str.split() is mainly useful for data that has been intentionally\n" "Note, str.split() is mainly useful for data that has been intentionally\n"
"delimited. With natural text that includes punctuation, consider using\n" "delimited. With natural text that includes punctuation, consider using\n"
"the regular expression module."); "the regular expression module.");
@ -1078,7 +1080,7 @@ PyDoc_STRVAR(unicode_rsplit__doc__,
" character (including \\n \\r \\t \\f and spaces) and will discard\n" " character (including \\n \\r \\t \\f and spaces) and will discard\n"
" empty strings from the result.\n" " empty strings from the result.\n"
" maxsplit\n" " maxsplit\n"
" Maximum number of splits (starting from the left).\n" " Maximum number of splits.\n"
" -1 (the default value) means no limit.\n" " -1 (the default value) means no limit.\n"
"\n" "\n"
"Splitting starts at the end of the string and works to the front."); "Splitting starts at the end of the string and works to the front.");
@ -1505,4 +1507,4 @@ skip_optional_pos:
exit: exit:
return return_value; return return_value;
} }
/*[clinic end generated code: output=873d8b3d09af3095 input=a9049054013a1b77]*/ /*[clinic end generated code: output=1aab29bab5201c78 input=a9049054013a1b77]*/

6
Objects/unicodeobject.c
View File

@ -12504,11 +12504,13 @@ str.split as unicode_split
character (including \n \r \t \f and spaces) and will discard character (including \n \r \t \f and spaces) and will discard
empty strings from the result. empty strings from the result.
maxsplit: Py_ssize_t = -1 maxsplit: Py_ssize_t = -1
Maximum number of splits (starting from the left). Maximum number of splits.
-1 (the default value) means no limit. -1 (the default value) means no limit.
Return a list of the substrings in the string, using sep as the separator string. 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 Note, str.split() is mainly useful for data that has been intentionally
delimited. With natural text that includes punctuation, consider using delimited. With natural text that includes punctuation, consider using
the regular expression module. the regular expression module.
@ -12517,7 +12519,7 @@ the regular expression module.
static PyObject * static PyObject *
unicode_split_impl(PyObject *self, PyObject *sep, Py_ssize_t maxsplit) 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) if (sep == Py_None)
return split(self, NULL, maxsplit); return split(self, NULL, maxsplit);