DOC:GH34026 #34059

moaraccounts · 2020-05-07T21:53:34Z

closes DOC: Series.str.rstrip() and Series.str.lstrip() have incorrect description at the top #34026
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

pep8speaks · 2020-05-07T21:53:39Z

Hello @moaraccounts! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-05-15 18:27:11 UTC

…ion-fixes

moaraccounts · 2020-05-08T16:56:57Z

EDIT: headdesk. I was on the wrong branch. Never mind. Should be good to go.

I'm not sure what I'm doing wrong. I'm following this guide
I just fixed the white space issues, then manually ran code_checks.sh for docstrings, lint, and patterns. I'm attaching those three outputs. I also ran git diff upstream/master -u -- "*.py" | flake8 --diff with no issues.

When I run git push origin <my-branch>, I receive Everything up-to-date. For some reason, the CI checks are still failing. Any suggestions?

check_docstrings.txt
check_lint.txt
check_patterns.txt

…das-dev#34026)

MarcoGorelli · 2020-05-09T12:53:46Z

Thanks @moaraccounts

CI failures are unrelated

Did you try building the documentation locally? https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#contributing-to-the-documentation

moaraccounts · 2020-05-13T17:48:17Z

Thanks @moaraccounts

CI failures are unrelated

Did you try building the documentation locally? https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#contributing-to-the-documentation

@MarcoGorelli Yes indeed. I can build the documentation locally and see my changes. Attached are the screenshots of rstrip and lstrip. Do those help?

MarcoGorelli

Cool, thanks for attaching the screenshots, looks good

MarcoGorelli · 2020-05-14T17:55:50Z

@moaraccounts mind if I ask why you closed this?

moaraccounts · 2020-05-14T17:58:25Z

Ooh, I thought since the changes were approved I could close it! My bad! I will reopen.

MarcoGorelli · 2020-05-14T18:00:32Z

It's OK :) A core dev will review this eventually (please be patient though, there's a long queue) and merge it

moaraccounts · 2020-05-14T18:03:46Z

Awesome! Ok, no worries on the waiting. Thank you!

MarcoGorelli · 2020-05-14T18:25:32Z

CI failures are unrelated

My bad, CI failures are related, you need to get

python scripts/validate_docstrings.py pandas.Series.str.lstrip

and

python scripts/validate_docstrings.py pandas.Series.str.rstrip

to pass

EDIT

python scripts/validate_docstrings.py pandas.Series.str.strip

too

MarcoGorelli · 2020-05-14T19:02:49Z

pandas/core/strings.py

@@ -2977,8 +2977,6 @@ def encode(self, encoding, errors="strict"):
    _shared_docs[
        "str_strip"
    ] = r"""
-    Remove leading and trailing characters.


It might be simpler to add a substitution here, something like

Suggested change

Remove leading and trailing characters.

Remove %(position)s characters.

and then, at the top of the def of lstrip, inside dict, add position="leading" (and similarly "trailing" for rstrip)

Gotcha, I see. Ok, I'll fix those then commit again. ty!

…n item to each dict. (pandas-dev34026)

MarcoGorelli · 2020-05-15T09:14:42Z

pandas/core/strings.py

@@ -3040,20 +3040,27 @@ def encode(self, encoding, errors="strict"):
    """

    @Appender(
-        _shared_docs["str_strip"] % dict(side="left and right sides", method="strip")
+        _shared_docs["str_strip"]
+        % dict(side="left and right sides", method="strip", position=None)


Doesn't strip remove both leading and trailing characters? Should this be

% dict(side="left and right sides", method="strip", position="leading and trailing")

?

Oh hell. Yes, it should have both leading and trailing. Fixing now and will push. Thank you.

…cumentation locally to confirm changes (pandas-dev34026)

MarcoGorelli

Thanks @moaraccounts - I built the docs locally and they look as expected

mroeschke · 2020-05-16T19:14:09Z

Thanks @moaraccounts! Nice contribution

* 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]>

moaraccounts · 2020-05-19T20:54:34Z

Thank you!

DOC:GH34026

f52f53f

simonjayhawkins added the Docs label May 8, 2020

Merge remote-tracking branch 'upstream/master' into pandas-documentat…

d274a76

…ion-fixes

DOC:Fixing desc. for Series.str.rstrip() and Series.str.lstrip() (pan…

8a6d8aa

…das-dev#34026)

MarcoGorelli approved these changes May 13, 2020

View reviewed changes

moaraccounts closed this May 14, 2020

moaraccounts reopened this May 14, 2020

mroeschke approved these changes May 14, 2020

View reviewed changes

mroeschke added this to the 1.1 milestone May 14, 2020

MarcoGorelli suggested changes May 14, 2020

View reviewed changes

DOC:Removed text strings from lstrip and rstrip. Added a new %positio…

b8df42c

…n item to each dict. (pandas-dev34026)

MarcoGorelli reviewed May 15, 2020

View reviewed changes

DOC:Fixed strip so %position now reads leading and trailing. Built do…

79b08bd

…cumentation locally to confirm changes (pandas-dev34026)

MarcoGorelli approved these changes May 16, 2020

View reviewed changes

mroeschke approved these changes May 16, 2020

View reviewed changes

mroeschke merged commit 9f7b9fc into pandas-dev:master May 16, 2020

moaraccounts deleted the pandas-documentation-fixes branch May 19, 2020 20:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC:GH34026 #34059

DOC:GH34026 #34059

moaraccounts commented May 7, 2020 •

edited

Loading

pep8speaks commented May 7, 2020 •

edited

Loading

moaraccounts commented May 8, 2020 •

edited

Loading

MarcoGorelli commented May 9, 2020

moaraccounts commented May 13, 2020

MarcoGorelli left a comment

MarcoGorelli commented May 14, 2020

moaraccounts commented May 14, 2020

MarcoGorelli commented May 14, 2020

moaraccounts commented May 14, 2020

MarcoGorelli commented May 14, 2020 •

edited

Loading

MarcoGorelli May 14, 2020

moaraccounts May 14, 2020

MarcoGorelli May 15, 2020 •

edited

Loading

moaraccounts May 15, 2020

MarcoGorelli left a comment

mroeschke commented May 16, 2020

moaraccounts commented May 19, 2020

	Remove leading and trailing characters.
	Remove %(position)s characters.

DOC:GH34026 #34059

DOC:GH34026 #34059

Conversation

moaraccounts commented May 7, 2020 • edited Loading

pep8speaks commented May 7, 2020 • edited Loading

Comment last updated at 2020-05-15 18:27:11 UTC

moaraccounts commented May 8, 2020 • edited Loading

MarcoGorelli commented May 9, 2020

moaraccounts commented May 13, 2020

MarcoGorelli left a comment

Choose a reason for hiding this comment

MarcoGorelli commented May 14, 2020

moaraccounts commented May 14, 2020

MarcoGorelli commented May 14, 2020

moaraccounts commented May 14, 2020

MarcoGorelli commented May 14, 2020 • edited Loading

EDIT

MarcoGorelli May 14, 2020

Choose a reason for hiding this comment

moaraccounts May 14, 2020

Choose a reason for hiding this comment

MarcoGorelli May 15, 2020 • edited Loading

Choose a reason for hiding this comment

moaraccounts May 15, 2020

Choose a reason for hiding this comment

MarcoGorelli left a comment

Choose a reason for hiding this comment

mroeschke commented May 16, 2020

moaraccounts commented May 19, 2020

moaraccounts commented May 7, 2020 •

edited

Loading

pep8speaks commented May 7, 2020 •

edited

Loading

moaraccounts commented May 8, 2020 •

edited

Loading

MarcoGorelli commented May 14, 2020 •

edited

Loading

MarcoGorelli May 15, 2020 •

edited

Loading