docs(python): Be more explicit about behaviour in str.strip_chars / strip_chars_start / strip_chars_end docstrings
#13697
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
henryharbeck
requested review from
ritchie46,
stinodego,
c-peters,
alexander-beedie and
MarcoGorelli
as code owners
github-actions
bot
added
documentation
stinodego
approved these changes
Jan 14, 2024
stinodego
changed the title
str.strip_chars / strip_chars_start / strip_chars_end docstrings
r-brink
pushed a commit
to r-brink/polars
that referenced
this pull request
Jan 24, 2024
… `strip_chars_start` / `strip_chars_end` docstrings (pola-rs#13697) Co-authored-by: Henry Harbeck <henry.harbeck@canstar.com.au>
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.
I found the following sentence in the docstring to (primarily in the case of
strip_chars) make it sound like characters anywhere in the string can be stripped, rather than just leading/trailing.With
strip_charsI missed the "Remove leading and trailing characters." sentence that provides all the additional context.This PR makes the behaviour of the methods more explicit throughout the docstring and removes wording that could pontentially be understood as conflicting.