mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

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

Browse source 
Co-authored-by: Erlend E. Aasland <erlend@python.org>
This commit is contained in:
Hugo van Kemenade 2023-12-22 09:43:38 +02:00 • committed by GitHub
parent beb1c6506c
commit a39131ed8c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -885,9 +885,11 @@ PyDoc_STRVAR(unicode_split__doc__,
" character (including \\n \\r \\t \\f and spaces) and will discard\n"
" empty strings from the result.\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"
"\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"
"delimited. With natural text that includes punctuation, consider using\n"
"the regular expression module.");
@ -986,7 +988,7 @@ PyDoc_STRVAR(unicode_rsplit__doc__,
" character (including \\n \\r \\t \\f and spaces) and will discard\n"
" empty strings from the result.\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"
"\n"
"Splitting starts at the end of the string and works to the front.");
@ -1353,4 +1355,4 @@ skip_optional_pos:
exit:
return return_value;
}
/*[clinic end generated code: output=11519887c1619a4e input=a9049054013a1b77]*/
/*[clinic end generated code: output=c25ec2c388409c94 input=a9049054013a1b77]*/

6
Objects/unicodeobject.c
View file

@ -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.
@ -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);