Skip to content

DOC: Series.str.rstrip() and Series.str.lstrip() have incorrect description at the top #34026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Dr-Irv opened this issue May 6, 2020 · 2 comments · Fixed by #34059
Closed

Comments

@Dr-Irv
Copy link
Contributor

Dr-Irv commented May 6, 2020

Location of the documentation

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.str.rstrip.html
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.str.lstrip.html

Documentation problem

At the top of the documentation for the rstrip() and lstrip() methods, it says "Remove leading and trailing characters."

Suggested fix for documentation

It should say "Remove trailing characters" for rstrip() and "Remove leading characters" for lstrip().

This is due to the way that the shared docs are set up between str.lstrip(), str.rstrip() and str.strip()

@Dr-Irv Dr-Irv added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels May 6, 2020
@MarcoGorelli MarcoGorelli added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels May 6, 2020
@moaraccounts
Copy link
Contributor

moaraccounts commented May 6, 2020

Hello! n00b here - I'll take this. @MarcoGorelli @Harshal96

@Harshal96
Copy link

Take @MarcoGorelli

@moaraccounts moaraccounts mentioned this issue May 7, 2020
5 tasks
mroeschke pushed a commit that referenced this issue May 16, 2020
* DOC:GH34026

* DOC:Fixing desc. for  Series.str.rstrip() and Series.str.lstrip() (#34026)

* DOC:Removed text strings from lstrip and rstrip. Added a new %position item to each dict. (pandas-dev34026)

* DOC:Fixed strip so %position now reads leading and trailing. Built documentation locally to confirm changes (pandas-dev34026)

Co-authored-by: Lesley <[email protected]>
jbrockmendel pushed a commit to jbrockmendel/pandas that referenced this issue May 17, 2020
* DOC:GH34026

* DOC:Fixing desc. for  Series.str.rstrip() and Series.str.lstrip() (pandas-dev#34026)

* DOC:Removed text strings from lstrip and rstrip. Added a new %position item to each dict. (pandas-dev34026)

* DOC:Fixed strip so %position now reads leading and trailing. Built documentation locally to confirm changes (pandas-dev34026)

Co-authored-by: Lesley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants