DOC: Fix Order of parameters in docstrings #23611

thoo · 2018-11-10T04:46:46Z

closes DOC: Fix order of parameters in the docstrings #23596
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff

Fix the following:

pandas.io.json.json_normalize: Wrong parameters order. Actual: ('data', 'record_path', 'meta', 'meta_prefix', 'record_prefix', 'errors', 'sep'). Documented: ('data', 'record_path', 'meta', 'record_prefix', 'meta_prefix', 'errors', 'sep')
pandas.crosstab: Wrong parameters order. Actual: ('index', 'columns', 'values', 'rownames', 'colnames', 'aggfunc', 'margins', 'margins_name', 'dropna', 'normalize'). Documented: ('index', 'columns', 'values', 'aggfunc', 'rownames', 'colnames', 'margins', 'margins_name', 'dropna', 'normalize')
pandas.Series.rolling: Wrong parameters order. Actual: ('window', 'min_periods', 'center', 'win_type', 'on', 'axis', 'closed'). Documented: ('window', 'min_periods', 'center', 'win_type', 'on', 'closed', 'axis')
pandas.DataFrame.rolling: Wrong parameters order. Actual: ('window', 'min_periods', 'center', 'win_type', 'on', 'axis', 'closed'). Documented: ('window', 'min_periods', 'center', 'win_type', 'on', 'closed', 'axis')
-pandas.DataFrame.to_html: Wrong parameters order. Actual: ('buf', 'columns', 'col_space', 'header', 'index', 'na_rep', 'formatters', 'float_format', 'sparsify', 'index_names', 'justify', 'bold_rows', 'classes', 'escape', 'max_rows', 'max_cols', 'show_dimensions', 'notebook', 'decimal', 'border', 'table_id'). Documented: ('buf', 'columns', 'col_space', 'header', 'index', 'na_rep', 'formatters', 'float_format', 'sparsify', 'index_names', 'justify', 'max_rows', 'max_cols', 'show_dimensions', 'bold_rows', 'classes', 'escape', 'notebook', 'decimal', 'border', 'table_id')
-pandas.DataFrame.to_string: Wrong parameters order. Actual: ('buf', 'columns', 'col_space', 'header', 'index', 'na_rep', 'formatters', 'float_format', 'sparsify', 'index_names', 'justify', 'line_width', 'max_rows', 'max_cols', 'show_dimensions'). Documented: ('buf', 'columns', 'col_space', 'header', 'index', 'na_rep', 'formatters', 'float_format', 'sparsify', 'index_names', 'justify', 'max_rows', 'max_cols', 'show_dimensions', 'line_width')
pandas.tseries.offsets.CustomBusinessDay: Wrong parameters order. Actual: ('n', 'normalize', 'weekmask', 'holidays', 'calendar', 'offset'). Documented: ('n', 'offset', 'normalize', 'weekmask', 'holidays', 'calendar')
pandas.tseries.offsets.CustomBusinessMonthEnd: Wrong parameters order. Actual: ('n', 'normalize', 'weekmask', 'holidays', 'calendar', 'offset'). Documented: ('n', 'offset', 'normalize', 'weekmask', 'holidays', 'calendar')
pandas.tseries.offsets.CustomBusinessMonthBegin: Wrong parameters order. Actual: ('n', 'normalize', 'weekmask', 'holidays', 'calendar', 'offset'). Documented: ('n', 'offset', 'normalize', 'weekmask', 'holidays', 'calendar')
pandas.tseries.offsets.CBMonthEnd: Wrong parameters order. Actual: ('n', 'normalize', 'weekmask', 'holidays', 'calendar', 'offset'). Documented: ('n', 'offset', 'normalize', 'weekmask', 'holidays', 'calendar')
pandas.tseries.offsets.CBMonthBegin: Wrong parameters order. Actual: ('n', 'normalize', 'weekmask', 'holidays', 'calendar', 'offset'). Documented: ('n', 'offset', 'normalize', 'weekmask', 'holidays', 'calendar')
pandas.tseries.offsets.CDay: Wrong parameters order. Actual: ('n', 'normalize', 'weekmask', 'holidays', 'calendar', 'offset'). Documented: ('n', 'offset', 'normalize', 'weekmask', 'holidays', 'calendar')
pandas.testing.assert_series_equal: Wrong parameters order. Actual: ('left', 'right', 'check_dtype', 'check_index_type', 'check_series_type', 'check_less_precise', 'check_names', 'check_exact', 'check_datetimelike_compat', 'check_categorical', 'obj'). Documented: ('left', 'right', 'check_dtype', 'check_index_type', 'check_series_type', 'check_less_precise', 'check_exact', 'check_names', 'check_datetimelike_compat', 'check_categorical', 'obj')```

pep8speaks · 2018-11-10T04:46:58Z

Hello @thoo! Thanks for submitting the PR.

There are no PEP8 issues in the file pandas/core/frame.py !
There are no PEP8 issues in the file pandas/core/generic.py !
There are no PEP8 issues in the file pandas/core/reshape/pivot.py !
There are no PEP8 issues in the file pandas/io/json/normalize.py !
There are no PEP8 issues in the file pandas/io/parsers.py !
There are no PEP8 issues in the file pandas/tseries/offsets.py !
There are no PEP8 issues in the file pandas/util/testing.py !

jreback

generally you cannot change the order of the kwargs themselves
just fix the doc strings. if it makes more sense and it has a lot of args then we need a note in the whatsnew

codecov · 2018-11-10T05:34:18Z

Codecov Report

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

@@           Coverage Diff           @@
##           master   #23611   +/-   ##
=======================================
  Coverage   92.25%   92.25%           
=======================================
  Files         161      161           
  Lines       51277    51277           
=======================================
  Hits        47305    47305           
  Misses       3972     3972

Flag	Coverage Δ
#multiple	`90.63% <ø> (ø)`	⬆️
#single	`42.32% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/reshape/pivot.py	`96.55% <ø> (ø)`	⬆️
pandas/core/window.py	`96.4% <ø> (ø)`	⬆️
pandas/tseries/offsets.py	`97.22% <ø> (ø)`	⬆️
pandas/util/testing.py	`86.71% <ø> (ø)`	⬆️
pandas/io/json/normalize.py	`96.87% <ø> (ø)`	⬆️

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 8ed92ef...5d7c5ce. Read the comment docs.

* upstream/master: TST: Use intp as expected dtype in IntervalIndex indexing tests (pandas-dev#23609)

datapythonista · 2018-11-10T10:31:14Z

@thoo I think in this case it makes more sense to change the order of the parameters, as you did initially. But let's do that in a separate PR, just leave the other changes here.

datapythonista · 2018-11-10T10:43:06Z

I created #23612 to address the changes in to_string and to_html.

* upstream/master: ENH: Support for partition_cols in to_parquet (pandas-dev#23321)

jschendel · 2018-11-10T16:38:34Z

pandas/core/window.py

@@ -472,6 +472,7 @@ class Window(_Window):
    on : string, optional
        For a DataFrame, column on which to calculate
        the rolling window, rather than the index
+    axis : int or string, default 0


when specifying parameter types: string --> str (a couple other instances of this elsewhere too)

jschendel · 2018-11-10T16:39:06Z

pandas/tseries/offsets.py

    normalize : bool, default False
        Normalize start/end dates to midnight before generating date range
    weekmask : str, Default 'Mon Tue Wed Thu Fri'
        weekmask of valid business days, passed to ``numpy.busdaycalendar``
    holidays : list
        list/array of dates to exclude from the set of valid business days,
        passed to ``numpy.busdaycalendar``
-    calendar : pd.HolidayCalendar or np.busdaycalendar
+    calendar : pd.HolidayCalendar or np.


looks like np.busdaycalendar accidentally got truncated?

datapythonista

lgtm, thanks @thoo for the work on this

jreback · 2018-11-11T14:51:13Z

thanks @thoo nice work!

@datapythonista is this check now automatic in code_checks? (if not, pls create an issue for this, if you don't already).

datapythonista · 2018-11-11T17:49:43Z

@jreback I'm adding the docstring checks that are ready to #23614 which still requires some work.

I'll add the validation of the order the parameters, but there too it'll still fail, until #23614 is merged.

* upstream/master: BUG: Casting tz-aware DatetimeIndex to object-dtype ndarray/Index (pandas-dev#23524) BUG: Delegate more of Excel parsing to CSV (pandas-dev#23544) API: DataFrame.__getitem__ returns Series for sparse column (pandas-dev#23561) CLN: use float64_t consistently instead of double, double_t (pandas-dev#23583) DOC: Fix Order of parameters in docstrings (pandas-dev#23611) TST: Unskip some Categorical Tests (pandas-dev#23613) TST: Fix integer ops comparison test (pandas-dev#23619) DOC: Fixes to docstring to add validation to CI (pandas-dev#23560) DOC: Remove incorrect periods at the end of parameter types (pandas-dev#23600) MAINT: tm.assert_raises_regex --> pytest.raises (pandas-dev#23592) DOC: Updating Series.resample and DataFrame.resample docstrings (pandas-dev#23197)

…fixed * upstream/master: DOC: Enhancing pivot / reshape docs (pandas-dev#21038) TST: Fix xfailing DataFrame arithmetic tests by transposing (pandas-dev#23620) BUILD: Simplifying contributor dependencies (pandas-dev#23522) BUG/REF: TimedeltaIndex.__new__ (pandas-dev#23539) BUG: Casting tz-aware DatetimeIndex to object-dtype ndarray/Index (pandas-dev#23524) BUG: Delegate more of Excel parsing to CSV (pandas-dev#23544) API: DataFrame.__getitem__ returns Series for sparse column (pandas-dev#23561) CLN: use float64_t consistently instead of double, double_t (pandas-dev#23583) DOC: Fix Order of parameters in docstrings (pandas-dev#23611) TST: Unskip some Categorical Tests (pandas-dev#23613) TST: Fix integer ops comparison test (pandas-dev#23619)

jreback requested changes Nov 10, 2018

View reviewed changes

thoo force-pushed the order_of_parameter branch from 681d919 to ff8ebf4 Compare November 10, 2018 04:57

correct orders

731d27e

thoo force-pushed the order_of_parameter branch from ff8ebf4 to 731d27e Compare November 10, 2018 06:28

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

c0e5c7f

* upstream/master: TST: Use intp as expected dtype in IntervalIndex indexing tests (pandas-dev#23609)

thoo added 2 commits November 10, 2018 10:45

drop to_html and to_string

954d90c

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

84e5ba7

* upstream/master: ENH: Support for partition_cols in to_parquet (pandas-dev#23321)

jschendel reviewed Nov 10, 2018

View reviewed changes

jschendel added the Docs label Nov 10, 2018

jschendel added this to the 0.24.0 milestone Nov 10, 2018

Change boolean,string to bool,str

5d7c5ce

datapythonista approved these changes Nov 10, 2018

View reviewed changes

datapythonista changed the title ~~Fix Order of parameters in docstrings~~ DOC: Fix Order of parameters in docstrings Nov 10, 2018

jreback approved these changes Nov 11, 2018

View reviewed changes

jreback merged commit 00ca0f9 into pandas-dev:master Nov 11, 2018

JustinZhengBC pushed a commit to JustinZhengBC/pandas that referenced this pull request Nov 14, 2018

DOC: Fix Order of parameters in docstrings (pandas-dev#23611)

c80ff12

tm9k1 pushed a commit to tm9k1/pandas that referenced this pull request Nov 19, 2018

DOC: Fix Order of parameters in docstrings (pandas-dev#23611)

e5de665

thoo deleted the order_of_parameter branch January 2, 2019 20:26

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Fix Order of parameters in docstrings (pandas-dev#23611)

050b0f5

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Fix Order of parameters in docstrings (pandas-dev#23611)

f989611

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Fix Order of parameters in docstrings #23611

DOC: Fix Order of parameters in docstrings #23611

thoo commented Nov 10, 2018 •

edited

Loading

pep8speaks commented Nov 10, 2018

jreback left a comment

codecov bot commented Nov 10, 2018 •

edited

Loading

datapythonista commented Nov 10, 2018

datapythonista commented Nov 10, 2018

jschendel Nov 10, 2018

jschendel Nov 10, 2018

thoo Nov 10, 2018

datapythonista left a comment

jreback commented Nov 11, 2018

datapythonista commented Nov 11, 2018

DOC: Fix Order of parameters in docstrings #23611

DOC: Fix Order of parameters in docstrings #23611

Conversation

thoo commented Nov 10, 2018 • edited Loading

pep8speaks commented Nov 10, 2018

jreback left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 10, 2018 • edited Loading

Codecov Report

datapythonista commented Nov 10, 2018

datapythonista commented Nov 10, 2018

jschendel Nov 10, 2018

Choose a reason for hiding this comment

jschendel Nov 10, 2018

Choose a reason for hiding this comment

thoo Nov 10, 2018

Choose a reason for hiding this comment

datapythonista left a comment

Choose a reason for hiding this comment

jreback commented Nov 11, 2018

datapythonista commented Nov 11, 2018

thoo commented Nov 10, 2018 •

edited

Loading

codecov bot commented Nov 10, 2018 •

edited

Loading