DOC: Fix Order of parameters in docstrings #23611
Conversation
|
Hello @thoo! Thanks for submitting the PR.
|
jreback
left a comment
jreback
left a comment
There was a problem hiding this comment.
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 Report
@@ Coverage Diff @@
## master #23611 +/- ##
=======================================
Coverage 92.25% 92.25%
=======================================
Files 161 161
Lines 51277 51277
=======================================
Hits 47305 47305
Misses 3972 3972
Continue to review full report at Codecov.
|
* upstream/master: TST: Use intp as expected dtype in IntervalIndex indexing tests (#23609)
|
@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. |
|
I created #23612 to address the changes in |
* upstream/master: ENH: Support for partition_cols in to_parquet (#23321)
pandas/core/window.py
Outdated
| on : string, optional | ||
| For a DataFrame, column on which to calculate | ||
| the rolling window, rather than the index | ||
| axis : int or string, default 0 |
There was a problem hiding this comment.
when specifying parameter types: string --> str (a couple other instances of this elsewhere too)
pandas/tseries/offsets.py
Outdated
| 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. |
There was a problem hiding this comment.
looks like np.busdaycalendar accidentally got truncated?
datapythonista
left a comment
datapythonista
left a comment
There was a problem hiding this comment.
lgtm, thanks @thoo for the work on this
datapythonista
changed the title
|
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). |
5 participants
git diff upstream/master -u -- "*.py" | flake8 --diffFix 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')```