DOC: fix PR09,PR08 doc string errors in Timestamp, NaT, Timedelta class #28674

josibake · 2019-09-29T20:48:20Z

This fixes PR09,PR08 errors in Timestamp, NaT, Timedelta classes

Example:

pandas.Timestamp.ceil: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.ceil: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.day_name: Parameter "locale" description should finish with "."
pandas.Timestamp.floor: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.floor: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.fromordinal: Parameter "ordinal" description should finish with "."
pandas.Timestamp.fromordinal: Parameter "freq" description should finish with "."
pandas.Timestamp.month_name: Parameter "locale" description should finish with "."
pandas.Timestamp.now: Parameter "tz" description should finish with "."
pandas.Timestamp.round: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.round: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.today: Parameter "tz" description should finish with "."
pandas.Timestamp.tz_localize: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.tz_localize: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.tz_localize: Parameter "errors" description should finish with "."

closes #28673

closes #xxxx
tests added / passed

This fixes Parameter {} description should finish with "." in the Timestamp class closes pandas-dev#28673

josibake · 2019-09-29T21:30:09Z

looks like the tests are failing due to:

compare = (<class 'pandas._libs.tslibs.timestamps.Timestamp'>, 'ceil')

    @pytest.mark.parametrize(
        "compare",
        (
            _get_overlap_public_nat_methods(Timestamp, True)
            + _get_overlap_public_nat_methods(Timedelta, True)
        ),
    )
    def test_nat_doc_strings(compare):
        # see gh-17327
        #
        # The docstrings for overlapping methods should match.
        klass, method = compare
        klass_doc = getattr(klass, method).__doc__

which i am assuming means i will also need to edit the Timedelta class

josibake · 2019-09-29T22:40:19Z

adding NaT, Timedelta class since it looks like I'll have to fix those too to get it to past the tests

docstrings for Timestamp, NaT and Timedelta classes must match for overlapping methods. verified they now pass the test_nat.py test

josibake · 2019-09-29T23:47:37Z

confirmed that this fixes PR09 for Timedelta,Timestamp,NaT classes:

./scripts/validate_docstrings.py --errors=PR09,PR08 | grep -E "Timedelta\.|Timestamp\.|NaT\."

josibake · 2019-09-30T16:33:29Z

this is related to #27977 and #28602 (adding for visibility)

datapythonista

Thanks for working on this, great PR. Added few minor comments, but looks good.

pandas/_libs/tslibs/nattype.pyx

This fixes Parameter {} description should finish with "." in the Timestamp class closes pandas-dev#28673

docstrings for Timestamp, NaT and Timedelta classes must match for overlapping methods. verified they now pass the test_nat.py test

change ambiguous parameter to be more readable remove the period after versionadd

josibake · 2019-10-01T01:05:24Z

sorry about re-adding all the commits @datapythonista ; something was screwed up with how I had my local branch set up. should be fixed now.

pandas/_libs/tslibs/nattype.pyx

pandas/_libs/tslibs/timestamps.pyx

missed a few periods from the last commit also incorrectly moved a sphinx directive earlier

WillAyd · 2019-10-01T15:48:56Z

pandas/core/algorithms.py

-        lag_indexer = tuple(lag_indexer)
+        # To keep mypy happy, _res_indexer is a list while res_indexer is
+        #  a tuple, ditto for lag_indexer.
+        _res_indexer = [slice(None)] * arr.ndim


I don't think this is supposed to be part of your PR. Are you sure you merged in the latest changes from upstream/master?

* DOC: Add scaling to large datasets section Closes pandas-dev#28315

)

josibake · 2019-10-01T16:59:28Z

apologies, i am a little confused on this one and cant figure out what im doing wrong. I ran:

git checkout PR09-Timestamp-fix
git fetch upstream
git merge upstream/master

but this adds more commits into the PR. let me read up on github docs and figure out what im doing and then ill take a another stab at opening a PR

DOC: fix PR09 doc string errors in Timestamp class

f3d45aa

This fixes Parameter {} description should finish with "." in the Timestamp class closes pandas-dev#28673

simonjayhawkins added the Docs label Sep 29, 2019

simonjayhawkins added this to the 1.0 milestone Sep 29, 2019

josibake changed the title ~~DOC: fix PR09 doc string errors in Timestamp class~~ DOC: fix PR09 doc string errors in Timestamp, NaT, Timedelta class Sep 29, 2019

Josiah Baker added 2 commits September 29, 2019 19:10

fix docstrings for Timestamp, NaT classes

a4ee42b

docstrings for Timestamp, NaT and Timedelta classes must match for overlapping methods. verified they now pass the test_nat.py test

fix unit description in Timedelta

70703e1

josibake changed the title ~~DOC: fix PR09 doc string errors in Timestamp, NaT, Timedelta class~~ DOC: fix PR09,PR08 doc string errors in Timestamp, NaT, Timedelta class Sep 30, 2019

datapythonista reviewed Sep 30, 2019

View reviewed changes

pandas/_libs/tslibs/nattype.pyx Outdated Show resolved Hide resolved

pandas/_libs/tslibs/nattype.pyx Outdated Show resolved Hide resolved

pandas/_libs/tslibs/nattype.pyx Show resolved Hide resolved

pandas/_libs/tslibs/nattype.pyx Outdated Show resolved Hide resolved

Josiah Baker added 5 commits September 30, 2019 20:27

DOC: fix PR09 doc string errors in Timestamp class

59f29e7

This fixes Parameter {} description should finish with "." in the Timestamp class closes pandas-dev#28673

fix docstrings for Timestamp, NaT classes

b58af1a

docstrings for Timestamp, NaT and Timedelta classes must match for overlapping methods. verified they now pass the test_nat.py test

fix unit description in Timedelta

5b99c06

change ambiguous param args and remove period

e3eb09e

change ambiguous parameter to be more readable remove the period after versionadd

fix merge conflict

aa5bae2

josibake requested a review from datapythonista October 1, 2019 01:38

WillAyd requested changes Oct 1, 2019

View reviewed changes

pandas/_libs/tslibs/nattype.pyx Show resolved Hide resolved

pandas/_libs/tslibs/nattype.pyx Outdated Show resolved Hide resolved

pandas/_libs/tslibs/nattype.pyx Outdated Show resolved Hide resolved

pandas/_libs/tslibs/timestamps.pyx Outdated Show resolved Hide resolved

jbrockmendel and others added 2 commits October 1, 2019 00:08

CLN: Assorted typings (pandas-dev#28604)

776451e

remove periods after versionadd and fix deprecated directive

962140f

missed a few periods from the last commit also incorrectly moved a sphinx directive earlier

josibake requested a review from WillAyd October 1, 2019 05:23

WillAyd requested changes Oct 1, 2019

View reviewed changes

jb8429 and others added 6 commits October 1, 2019 12:10

DOC: Fixed PR08 docstring errors in pandas.tseries (pandas-dev#28571)

225d5e2

DOC: Add scaling to large datasets section (pandas-dev#28577)

4661d77

* DOC: Add scaling to large datasets section Closes pandas-dev#28315

BUG: restore limit in RangeIndex.get_indexer (pandas-dev#28671)

c9b6f83

DOC: Fixed PR09 docstring errors in pandas.tseries (pandas-dev#27977) (…

d68e9fb

…pandas-dev#28707)

CI Failing: TestReadHtml.test_spam_url pandas-dev#28708 (pandas-dev#2…

2ad3704

…8710)

TST: un-xfail incorrectly xfailed tests for maybe_promote (pandas-dev…

5ec718a

…#28564)

jbrockmendel and others added 8 commits October 1, 2019 12:10

CLN: Define and pin GroupBy properties without exec (pandas-dev#28651)

dc67804

DOC: Fixed PR08, PR09 doctring issues in pandas.core.groupby (pandas-…

c794bbf

…dev#28709)

DOC: Fixed PR06 docstring errors in pandas.DataFrame (pandas-dev#28718)

4e371c1

DOC: Fixed PR06 docstrings errors in pandas.arrays.IntervalArray (pan…

21f6505

…das-dev#28721)

DOC: fix PR09,PR08 docstring errors in pandas.plotting (pandas-dev#28689

7e05957

)

precursor to Split out test_pytables.py to sub-module of tests (panda…

dd028fd

…s-dev#28715)

fix merge conflict

c5bc928

Merge remote-tracking branch 'upstream/master' into PR09-Timestamp-fix

8bcda1d

josibake closed this Oct 1, 2019

josibake deleted the PR09-Timestamp-fix branch October 3, 2019 23:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: fix PR09,PR08 doc string errors in Timestamp, NaT, Timedelta class #28674

DOC: fix PR09,PR08 doc string errors in Timestamp, NaT, Timedelta class #28674

josibake commented Sep 29, 2019 •

edited

Loading

josibake commented Sep 29, 2019

josibake commented Sep 29, 2019

josibake commented Sep 29, 2019 •

edited

Loading

josibake commented Sep 30, 2019

datapythonista left a comment

josibake commented Oct 1, 2019

WillAyd Oct 1, 2019

josibake commented Oct 1, 2019

DOC: fix PR09,PR08 doc string errors in Timestamp, NaT, Timedelta class #28674

DOC: fix PR09,PR08 doc string errors in Timestamp, NaT, Timedelta class #28674

Conversation

josibake commented Sep 29, 2019 • edited Loading

josibake commented Sep 29, 2019

josibake commented Sep 29, 2019

josibake commented Sep 29, 2019 • edited Loading

josibake commented Sep 30, 2019

datapythonista left a comment

Choose a reason for hiding this comment

josibake commented Oct 1, 2019

WillAyd Oct 1, 2019

Choose a reason for hiding this comment

josibake commented Oct 1, 2019

josibake commented Sep 29, 2019 •

edited

Loading

josibake commented Sep 29, 2019 •

edited

Loading