summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2023-12-22 07:43:38 (GMT)
committerGitHub <noreply@github.com>2023-12-22 07:43:38 (GMT)
commita39131ed8c3dd7a1bfc375fc4f38a9e2eb489636 (patch)
treee9338f13776a6db3f691b6d5633f088d5dc99cd3
parentbeb1c6506c8ff77ddc73f763e94122640f0feb8d (diff)
downloadcpython-a39131ed8c3dd7a1bfc375fc4f38a9e2eb489636.zip
cpython-a39131ed8c3dd7a1bfc375fc4f38a9e2eb489636.tar.gz
cpython-a39131ed8c3dd7a1bfc375fc4f38a9e2eb489636.tar.bz2
[3.11] gh-110383: Improve accuracy of str.split() and str.rsplit() docstrings (GH-113355) (#113380)
Co-authored-by: Erlend E. Aasland <erlend@python.org>
-rw-r--r--Objects/clinic/unicodeobject.c.h8
-rw-r--r--Objects/unicodeobject.c6
2 files changed, 9 insertions, 5 deletions
diff --git a/Objects/clinic/unicodeobject.c.h b/Objects/clinic/unicodeobject.c.h
index 7a42cd8..0f1dd7c 100644
--- a/Objects/clinic/unicodeobject.c.h
+++ b/Objects/clinic/unicodeobject.c.h
@@ -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]*/
diff --git a/Objects/unicodeobject.c b/Objects/unicodeobject.c
index c27fc00..47c4e2a 100644
--- a/Objects/unicodeobject.c
+++ b/Objects/unicodeobject.c
@@ -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);