Fix PR10 error and Clean up docstrings from functions related to RT05 errors #25132

thoo · 2019-02-04T04:00:34Z

~~closes Fix validation error type RT05 and check in CI #25108~~ Related to Fix validation error type RT05 and check in CI #25108 ,DOC: Fixes to docstrings and add PR10 (space before colon) to validation #25109
tests added / passed (./scripts/validate_docstrings.py --errors=RT05)
passes git diff upstream/master -u -- "*.py" | flake8 --diff

pep8speaks · 2019-02-04T04:00:52Z

Hello @thoo! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on February 28, 2019 at 01:28 Hours UTC

codecov · 2019-02-04T04:35:24Z

Codecov Report

Merging #25132 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #25132   +/-   ##
=======================================
  Coverage   92.37%   92.37%           
=======================================
  Files         166      166           
  Lines       52408    52408           
=======================================
  Hits        48411    48411           
  Misses       3997     3997

Flag	Coverage Δ
#multiple	`90.79% <ø> (ø)`	⬆️
#single	`42.86% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/tools/numeric.py	`100% <ø> (ø)`	⬆️
pandas/core/arrays/datetimelike.py	`97.67% <ø> (ø)`	⬆️
pandas/core/indexes/multi.py	`95.6% <ø> (ø)`	⬆️
pandas/core/series.py	`93.68% <ø> (ø)`	⬆️
pandas/core/panel.py	`97.91% <ø> (ø)`	⬆️
pandas/tseries/frequencies.py	`97.7% <ø> (ø)`	⬆️
pandas/core/frame.py	`96.81% <ø> (ø)`	⬆️
pandas/io/formats/style.py	`96.69% <ø> (ø)`	⬆️
pandas/core/generic.py	`96.63% <ø> (ø)`	⬆️
pandas/plotting/_core.py	`83.58% <ø> (ø)`	⬆️
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d3c9d6e...2c4455c. Read the comment docs.

codecov · 2019-02-04T04:35:35Z

Codecov Report

Merging #25132 into master will decrease coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #25132      +/-   ##
==========================================
- Coverage   91.74%   91.74%   -0.01%     
==========================================
  Files         173      173              
  Lines       52923    52923              
==========================================
- Hits        48555    48554       -1     
- Misses       4368     4369       +1

Flag	Coverage Δ
#multiple	`90.31% <100%> (ø)`	⬆️
#single	`41.73% <100%> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/arrays/datetimelike.py	`97.67% <ø> (ø)`	⬆️
pandas/core/indexes/multi.py	`95.62% <ø> (ø)`	⬆️
pandas/core/series.py	`93.68% <ø> (ø)`	⬆️
pandas/tseries/frequencies.py	`97.7% <ø> (ø)`	⬆️
pandas/core/frame.py	`96.85% <ø> (ø)`	⬆️
pandas/core/generic.py	`94.16% <ø> (ø)`	⬆️
pandas/core/algorithms.py	`94.77% <ø> (ø)`	⬆️
pandas/plotting/_misc.py	`38.68% <ø> (ø)`	⬆️
pandas/core/arrays/categorical.py	`95.97% <ø> (ø)`	⬆️
pandas/io/excel/_base.py	`92.48% <ø> (ø)`	⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c986386...2d62018. Read the comment docs.

jreback · 2019-02-04T12:57:07Z

can you merge master. RT04 is now active, so I think you need to adjust some things.

* upstream/master: TST/REF: collect DataFrame reduction tests (#24914) DOC: Improve docstring of Series.mul (#25136) Removal of return variable names (#25123) BUG: Fixing regression in DataFrame.all and DataFrame.any with bool_only=True (#25102) Reading a HDF5 created in py2 (#25058) DOC: Fix validation type error RT04 (#25107) (#25129)

pandas/core/generic.py

* upstream/master: Fix validation error type `SS05` and check in CI (#25133)

datapythonista

Looks good, some special cases can probably be improved

ci/code_checks.sh

pandas/core/algorithms.py

pandas/core/arrays/categorical.py

pandas/core/arrays/datetimelike.py

pandas/plotting/_core.py

pandas/plotting/_misc.py

pandas/tseries/frequencies.py

* upstream/master: DOC: Fix validation type error SA05 (#25208) REF: Add more pytest idiom to test_holiday.py (#25204) DOC/CLN: Fix errors in Series docstrings (#24945) TST: follow-up to Test nested pandas array #24993 (#25155) modernize compat imports (#25192) fix MacPython pandas-wheels failure (#25186) BUG: DataFrame.merge(suffixes=) does not respect None (#24819) DEPR: remove PanelGroupBy, disable DataFrame.to_panel (#25047) DOC: update docstring for series.nunique (#25116) CLN: Use ABCs in set_index (#25128) BLD: pin cython language level to '2' (#25145) DOC: Updates to Timestamp document (#25163) STY: use pytest.raises context manager (indexes/multi) (#25175) Fixed tuple to List Conversion in Dataframe class (#25089)

* upstream/master: fix ci failures (#25225) STY: use pytest.raises context manager (indexes/period) (#25199) DOC: exclude autogenerated c/cpp/html files from 'trailing whitespace' checks (#24549) DOC: Fixes to docstrings and add PR10 (space before colon) to validation (#25109) REF: Remove many Panel tests (#25191) BUG: Fix Series.is_unique with single occurrence of NaN (#25182)

jreback · 2019-02-09T17:43:55Z

@datapythonista if you'd re-look. merge when good.

* upstream/master: BUG: Fix exceptions when Series.interpolate's `order` parameter is missing or invalid (#25246) API: Ensure DatetimeTZDtype standardizes pytz timezones (#25254) Split Excel IO Into Sub-Directory (#25153) PR04 errors fix (#25157) DEPR: remove assert_panel_equal (#25238) BUG: pandas Timestamp tz_localize and tz_convert do not preserve `freq` attribute (#25247) Revert "BLD: prevent asv from calling sys.stdin.close() by using different launch method (#25237)" (#25253) REF/TST: resample/test_base.py (#25262) BUG: Duplicated returns boolean dataframe (#25234) CLN: Remove ipython 2.x compat (#25150) Refactor groupby group_add from tempita to fused types (#24954) CLN: For loops, boolean conditions, misc. (#25206) (Closes #25029) Removed extra bracket from cheatsheet code example. (#25032) BLD: prevent asv from calling sys.stdin.close() by using different launch method (#25237) BUG: Fix read_json orient='table' without index (#25170) (#25171) BUG: Fix regression in DataFrame.apply causing RecursionError (#25230) BUG-25061 fix printing indices with NaNs (#25202) DEPR: Add Deprecated warning for timedelta with passed units M and Y (#23264) DEPR: Remove Panel-specific parts of io.pytables (#25233) DEPR: remove tm.makePanel and all usages (#25231)

datapythonista

Great job, thanks for all the fixes. Just few comments.

datapythonista · 2019-02-13T17:16:59Z

pandas/core/algorithms.py

-      If the input is an Index, the return is an Index
-      If the input is a Categorical dtype, the return is a Categorical
-      If the input is a Series/ndarray, the return will be an ndarray
+    unique values


This should be the type, can you find out what's the returned Python type, and move this to the description please?

datapythonista · 2019-02-13T17:17:34Z

pandas/core/arrays/categorical.py


        Returns
        -------
        values : numpy array


Suggested change

values : numpy array

numpy.array

datapythonista · 2019-02-13T17:17:44Z

pandas/core/arrays/categorical.py


        Returns
        -------
        values : numpy array


Suggested change

values : numpy array

numpy.array

datapythonista · 2019-02-13T17:18:09Z

pandas/core/frame.py

        Returns
        -------
-        value : scalar value
+        scalar value


Suggested change

scalar value

scalar

datapythonista · 2019-02-13T17:18:22Z

pandas/core/frame.py

        Returns
        -------
-        sanitized_column : numpy-array
+        numpy-array


Suggested change

numpy-array

numpy.array

datapythonista · 2019-02-13T17:25:58Z

pandas/plotting/_core.py

        Returns
        -------
-        axes : matplotlib.AxesSubplot histogram.
+        matplotlib.AxesSubplot histogram.


Leave just the type, say it's a Histogram in the description.

datapythonista · 2019-02-13T17:26:49Z

pandas/plotting/_misc.py

    Returns
    -------
-    ax : Matplotlib axis object
+    Matplotlib axis object


Suggested change

Matplotlib axis object

class:`matplotlib.axes.Axes`

There are many like this afterwards

datapythonista · 2019-02-13T17:26:57Z

pandas/plotting/_misc.py

    Returns
    -------
-    ax: matplotlib axis object
+    matplotlib axis object


Suggested change

matplotlib axis object

class:`matplotlib.axes.Axes`

datapythonista · 2019-02-13T17:27:02Z

pandas/plotting/_misc.py

    Returns
    -------
-    ax: Matplotlib axis object
+    Matplotlib axis object


Suggested change

Matplotlib axis object

class:`matplotlib.axes.Axes`

datapythonista · 2019-02-13T17:27:07Z

pandas/plotting/_misc.py

    Returns:
    -----------
-    ax: Matplotlib axis object
+    Matplotlib axis object


Suggested change

Matplotlib axis object

class:`matplotlib.axes.Axes`

thoo · 2019-02-14T19:38:49Z

@datapythonista I think #25108 is already closed by #25309. Should I fix with your suggestions which are not covered by #25309? Or just close this PR and submit the new one?

WillAyd · 2019-02-14T19:42:06Z

@thoo sorry didn't realize we had two PRs for this and other is already merged for RT05. Are there other elements to this outside of that you are trying to merge?

jreback · 2019-02-17T17:27:37Z

pls merge master again

* upstream/master: TST: xfail excel styler tests, xref GH25351 (#25352)

jreback · 2019-02-19T14:05:37Z

cc @datapythonista

datapythonista

lgtm, thanks @thoo

WillAyd · 2019-02-20T15:41:47Z

ci/code_checks.sh


-    MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, PR10, EX04, RT04, RT05, SS05, SA05)' ; echo $MSG
-    $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR04,PR05,EX04,RT04,RT05,SS05,SA05
+    MSG='Validate docstrings (GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, EX04, RT04, RT05, SA05)' ; echo $MSG


Was there a reason for removing PR10 here or just mistake?

~~It is just a mistake from merge.~~

PR10 is actually not included in the current check at line 245. So I wasn't sure someone exclude PR10 but forgot to remove from the message.

Good catch. I think this was just missed in #25109 so makes sense to update here accordingly

##[error]pandas/io/excel/_base.py(492,): error PR10: pandas.ExcelWriter: Parameter ".. versionadded" requires a space before the colon separating the parameter name and type

~~PR10 is not passing the check with .. versionadded:: 0.24.. I am going to leave PR10 for now.~~ Update pandas.ExcelWriter

WillAyd · 2019-02-20T15:43:53Z

pandas/core/series.py

            * Interval
            * Sparse
-            * IntegerNA
+            * IntegerNA .


I've seen this on quite a few other requests. Nuanced but I'm personally of the opinion that this is a "hack" to pass validation so would prefer another route. Can you just add a one-line description after the bullet points instead?

pandas/core/generic.py

* upstream/master: API: more consistent error message for MultiIndex.from_arrays (#25189) fix typo of see also in DataFrame stat funcs (#25388) edited whatsnew typo (#25381) REGR: fix TimedeltaIndex sum and datetime subtraction with NaT (#25282, #25317) (#25329) ENH: indexing and __getitem__ of dataframe and series accept zerodim integer np.array as int (#24924) [CLN] Excel Module Cleanups (#25275) Interval dtype fix (#25338) BUG/ENH: Timestamp.strptime (#25124) 14873: test for groupby.agg coercing booleans (#25327) [BUG] exception handling of MultiIndex.__contains__ too narrow (#25268) 9236: test for the DataFrame.groupby with MultiIndex having pd.NaT (#25310) #23049: test for Fatal Stack Overflow stemming From Misuse of astype('category') (#25366) Remove spurious MultiIndex creation in `_set_axis_name` (#25371) DOC: modify typos in Contributing section (#25365) DOC/BLD: fix --no-api option (#25209) DOC: Correct doc mistake in combiner func (#25360)

WillAyd · 2019-02-21T02:29:59Z

@thoo looking pretty good thanks for addressing comments. Can you update title to reflect what this PR is actually addressing, since it's no longer RT05?

WillAyd

Minor things but otherwise lgtm and thanks for updating title.

@datapythonista - some changes since your last approval do you mind taking a look again?

pandas/core/generic.py

WillAyd · 2019-02-21T16:49:35Z

pandas/core/generic.py

+        - If DataFrame.agg is called with several functions, returns
+          a DataFrame.
+        - If Series.agg is called with single function, returns a scalar.
+        - If Series.agg is called with several functions, returns a Series.


Let's do the same thing you are doing below, where instead of putting periods at the end of each bullet you end with a short sentence after the bullets

WillAyd · 2019-02-21T16:49:55Z

pandas/core/algorithms.py

+
+        - If the input is an Index, the return is an Index.
+        - If the input is a Categorical dtype, the return is a Categorical.
+        - If the input is a Series/ndarray, the return will be an ndarray.


Same comment here around periods for bullet points

datapythonista

looks good, jut couple of comments more besides the ones already mentioned

datapythonista · 2019-02-21T17:02:32Z

pandas/core/indexes/base.py

+        indexer, keyarr
            indexer is an ndarray or None if cannot convert
-            keyarr are tuple-safe keys
+            keyarr are tuple-safe keys.


do you mind documenting both parameters separately? It's done in other parts of this PR

pandas/core/series.py

datapythonista · 2019-02-21T17:03:38Z

pandas/io/excel/_base.py

-        File mode to use (write or append).
-
-    .. versionadded:: 0.24.0
+        File mode to use (write or append). .. versionadded:: 0.24.0


is there a reason for this? Not sure if this will render correctly in the html

Yeah, that's right. I was about to fix it.

* upstream/master: CLN: (re-)enable infer_dtype to catch complex (#25382)

datapythonista

All good, just the Returns with the creative documenting of multiple values needs to be fixed

datapythonista · 2019-02-22T10:15:42Z

pandas/core/indexes/base.py

+            - indexer : an ndarray or None if cannot convert
+            - keyarr : tuple-safe keys
+
+            Return indexer, keyarr.


Can you check in this diff the previous change? That's how a Return with multiple values is documented.

WillAyd · 2019-02-27T23:24:18Z

@thoo can you merge master and ping on green?

* upstream/master: DOC: CategoricalIndex doc string (#24852) CI: add __init__.py to isort skip list (#25455) TST: numpy RuntimeWarning with Series.round() (#25432) DOC: fixed geo accessor example in extending.rst (#25420) BUG: fixed merging with empty frame containing an Int64 column (#25183) (#25289) TST: remove never-used singleton fixtures (#24885) PERF/REF: improve performance of Series.searchsorted, PandasArray.searchsorted, collect functionality (#22034) BUG: Indexing with UTC offset string no longer ignored (#25263) API/ERR: allow iterators in df.set_index & improve errors (#24984) DOC: Rewriting of ParserError doc + minor spacing (#25421) ENH: Add in sort keyword to DatetimeIndex.union (#25110) ERR: doc update for ParsingError (#25414) BUG: Fix type coercion in read_json orient='table' (#21345) (#25219) DEP: add pytest-mock to environment.yml (#25417) Correct a typo of version number for interpolate() (#25418) Mark test_pct_max_many_rows as high memory (#25400) DOC: Edited docstring of Interval (#25410)

thoo · 2019-03-01T01:31:53Z

@WillAyd All checks passed.

WillAyd · 2019-03-01T01:46:54Z

Thanks @thoo !

Fix validation error RT05

2c4455c

Fix pep8

c87102f

jreback added the Docs label Feb 4, 2019

thoo added 3 commits February 4, 2019 10:31

fix merge conflict

03aaa92

fix RT04

36a610a

jreback reviewed Feb 4, 2019

View reviewed changes

pandas/core/generic.py Outdated Show resolved Hide resolved

thoo added 3 commits February 4, 2019 19:44

fix as recommended

c2e24b3

Merge remote-tracking branch 'upstream/master' into Rt05

f5cfc8a

* upstream/master: Fix validation error type `SS05` and check in CI (#25133)

fix bullets

6e658f8

datapythonista requested changes Feb 5, 2019

View reviewed changes

thoo added 7 commits February 5, 2019 20:05

fix upon suggestions

5304b9c

fix upon suggestions

7601aed

fix failing tests

128dadb

replace with bullet

3d3e408

typo

522e76d

Retrigger :pandas-dev conda 27 failed

163e9e3

jreback added this to the 0.25.0 milestone Feb 8, 2019

thoo added 2 commits February 8, 2019 15:00

update code_checks.sh

25e7503

datapythonista reviewed Feb 13, 2019

View reviewed changes

Retrigger :pandas-devs failed second time

6ac909b

thoo added 2 commits February 17, 2019 13:00

Retrigger :pandas-devs failed second time

4e4f24a

Merge remote-tracking branch 'upstream/master' into Rt05

283861f

* upstream/master: TST: xfail excel styler tests, xref GH25351 (#25352)

datapythonista approved these changes Feb 20, 2019

View reviewed changes

WillAyd requested changes Feb 20, 2019

View reviewed changes

thoo added 3 commits February 20, 2019 14:21

fix at Series.unique

953159c

add PR10

94e5279

drop PR10

39ab010

thoo changed the title ~~Fix validation error type RT05 and check in CI~~ ~Fix validation error type RT05 and check in CI~ Clean up docstrings from functions related to RT05 errors Feb 21, 2019

thoo changed the title ~~~Fix validation error type RT05 and check in CI~ Clean up docstrings from functions related to RT05 errors~~ Clean up docstrings from functions related to RT05 errors Feb 21, 2019

fix PR10 error

64bd51b

thoo changed the title ~~Clean up docstrings from functions related to RT05 errors~~ Fix PR10 error and Clean up docstrings from functions related to RT05 errors Feb 21, 2019

WillAyd requested changes Feb 21, 2019

View reviewed changes

datapythonista reviewed Feb 21, 2019

View reviewed changes

thoo added 2 commits February 21, 2019 23:38

fix as recommended

7051e3c

Merge remote-tracking branch 'upstream/master' into Rt05

a35f869

* upstream/master: CLN: (re-)enable infer_dtype to catch complex (#25382)

datapythonista requested changes Feb 22, 2019

View reviewed changes

fix as recommended

b847e4e

WillAyd approved these changes Feb 27, 2019

View reviewed changes

WillAyd mentioned this pull request Feb 28, 2019

[DOC] Fix issues with DataFrame.aggregate page #24948

Closed

WillAyd merged commit 0a61ecd into pandas-dev:master Mar 1, 2019

Uh oh!

Fix PR10 error and Clean up docstrings from functions related to RT05 errors #25132

Fix PR10 error and Clean up docstrings from functions related to RT05 errors #25132

Uh oh!

Conversation

thoo commented Feb 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pep8speaks commented Feb 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated on February 28, 2019 at 01:28 Hours UTC

Uh oh!

codecov bot commented Feb 4, 2019

Codecov Report

Uh oh!

codecov bot commented Feb 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jreback commented Feb 4, 2019

Uh oh!

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jreback commented Feb 9, 2019

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thoo commented Feb 14, 2019

Uh oh!

WillAyd commented Feb 14, 2019

Uh oh!

jreback commented Feb 17, 2019

Uh oh!

jreback commented Feb 19, 2019

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thoo Feb 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thoo Feb 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

thoo commented Feb 4, 2019 •

edited

Loading

pep8speaks commented Feb 4, 2019 •

edited

Loading

codecov bot commented Feb 4, 2019 •

edited

Loading

thoo Feb 20, 2019 •

edited

Loading

thoo Feb 20, 2019 •

edited

Loading

thoo Feb 21, 2019 •

edited

Loading