gh-110383: Fix docstring for str.rsplit maxsplit param to 'starting from the right' #113353
Conversation
This file contains 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
Previously the parameters including their docstrings were cloned from `str.split` but that says 'starting from the left' which is not correct for `str.rsplit`. It is not possible to partially clone or modify according to: https://devguide.python.org/development-tools/clinic/#how-to-clone-existing-functions so copy from `split` and modify as necessary.
|
I propose a different approach in #113355. |
|
Thanks for your PR. While this approach fixes the problem, I hesitate with it slightly, since it duplicates a lot of lines. For example, we will now have to make sure both I propose instead to change the wording in the param docstring, and instead clarify how the two functions operate in the docstring body. I'm not sure which variant is clearest for the user. |
|
Thanks for your interest in improving CPython :) |
|
Fair enough, thanks! |
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.
Previously the parameters including their docstrings were cloned from
str.splitbut that says 'starting from the left' which is not correct forstr.rsplit.It is not possible to partially clone or modify according to: https://devguide.python.org/development-tools/clinic/#how-to-clone-existing-functions so copy from
splitand modify as necessary.This follows on from #111247 hopefully addressing the feedback there.