gh-110383: Improve accuracy of str.split() and str.rsplit() docstrings #113355
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…strings Mention split direction in the docstring body, instead of in the 'maxsplit' param docstring.
erlend-aasland
added
skip news
needs backport to 3.11
hugovk
approved these changes
Dec 21, 2023
There was a problem hiding this comment.
Looks good:
❯ ./python.exe
Python 3.13.0a2+ (heads/splitter!-dirty:c50dd463dd, Dec 21 2023, 14:51:45) [Clang 15.0.0 (clang-1500.1.0.2.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> help(str().split)
Help on built-in function split:
split(sep=None, maxsplit=-1) method of builtins.str instance
Return a list of the substrings in the string, using sep as the separator string.
sep
The separator used to split the string.
When set to None (the default value), will split on any whitespace
character (including \n \r \t \f and spaces) and will discard
empty strings from the result.
maxsplit
Maximum number of splits.
-1 (the default value) means no limit.
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.
>>> help(str().rsplit)
Help on built-in function rsplit:
rsplit(sep=None, maxsplit=-1) method of builtins.str instance
Return a list of the substrings in the string, using sep as the separator string.
sep
The separator used to split the string.
When set to None (the default value), will split on any whitespace
character (including \n \r \t \f and spaces) and will discard
empty strings from the result.
maxsplit
Maximum number of splits.
-1 (the default value) means no limit.
Splitting starts at the end of the string and works to the front.
>>>Thanks everyone!
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as off-topic.
This comment was marked as off-topic.
|
GH-113379 is a backport of this pull request to the 3.12 branch. |
hugovk
pushed a commit
to hugovk/cpython
that referenced
this pull request
Dec 21, 2023
…t() docstrings (pythonGH-113355) Clarify split direction in the docstring body, instead of in the 'maxsplit' param docstring. (cherry picked from commit 526d0a9) Co-authored-by: Erlend E. Aasland <[email protected]>
|
GH-113380 is a backport of this pull request to the 3.11 branch. |
hugovk
pushed a commit
to hugovk/cpython
that referenced
this pull request
Dec 21, 2023
…t() docstrings (pythonGH-113355) Clarify split direction in the docstring body, instead of in the 'maxsplit' param docstring. (cherry picked from commit 526d0a9) Co-authored-by: Erlend E. Aasland <[email protected]>
hugovk
added a commit
that referenced
this pull request
Dec 22, 2023
…cstrings (GH-113355) (#113379) Co-authored-by: Erlend E. Aasland <[email protected]>
hugovk
added a commit
that referenced
this pull request
Dec 22, 2023
…cstrings (GH-113355) (#113380) Co-authored-by: Erlend E. Aasland <[email protected]>
ryan-duve
pushed a commit
to ryan-duve/cpython
that referenced
this pull request
Dec 26, 2023
…strings (python#113355) Clarify split direction in the docstring body, instead of in the 'maxsplit' param docstring.
kulikjak
pushed a commit
to kulikjak/cpython
that referenced
this pull request
Jan 22, 2024
…strings (python#113355) Clarify split direction in the docstring body, instead of in the 'maxsplit' param docstring.
aisk
pushed a commit
to aisk/cpython
that referenced
this pull request
Feb 11, 2024
…strings (python#113355) Clarify split direction in the docstring body, instead of in the 'maxsplit' param docstring.
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this pull request
Sep 2, 2024
…strings (python#113355) Clarify split direction in the docstring body, instead of in the 'maxsplit' param docstring.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mention split direction in the docstring body,
instead of in the 'maxsplit' param docstring.