Skip to content

DOC: Fixes to docstrings and add PR10 (space before colon) to validation #25109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jreback merged 7 commits into from
Feb 8, 2019
Merged

DOC: Fixes to docstrings and add PR10 (space before colon) to validation #25109

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
da5669e
added type set_option docstring in config.py
Feb 3, 2019
6004ac3
added type to boxplot_frame_groupby docstring in plotting/_corew.py
Feb 3, 2019
bacc17a
indented versionadded in ExcelWriter docstring io/excel.py
Feb 3, 2019
6d6e054
updated code_check.sh to take into account PR10 type errors
Feb 3, 2019
dcf11aa
updated type in plotting/_core.py
Feb 4, 2019
d07e63b
Resolved conflict by incorporating both suggestions.
Feb 7, 2019
fc8b1c4
modified type to object for value variable in config.py
Feb 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,8 +240,8 @@ fi
### DOCSTRINGS ###
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, EX04)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR05,EX04
MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, PR10, EX04)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR05,PR10,EX04
RET=$(($RET + $?)) ; echo $MSG "DONE"

fi
Expand Down
4 changes: 2 additions & 2 deletions pandas/core/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,8 +282,8 @@ def __doc__(self):
Note: partial matches are supported for convenience, but unless you use the
full option name (e.g. x.y.z.option_name), your code may break in future
versions if new options with similar names are introduced.
value :
new value of option.
value : str, int, float, bool
Copy link
Copy Markdown
Member

@datapythonista datapythonista Feb 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this can be anything, may be we could say just object

Suggested change
value : str, int, float, bool
value : object

New value of option.

Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion pandas/io/excel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1002,7 +1002,7 @@ class ExcelWriter(object):
mode : {'w' or 'a'}, default 'w'
File mode to use (write or append).

.. versionadded:: 0.24.0
.. versionadded:: 0.24.0

Attributes
----------
Expand Down
2 changes: 1 addition & 1 deletion pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2548,7 +2548,7 @@ def boxplot_frame_groupby(grouped, subplots=True, column=None, fontsize=None,
Parameters
----------
grouped : Grouped DataFrame
subplots :
subplots : bol
Copy link
Copy Markdown
Member

@datapythonista datapythonista Feb 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
subplots : bol
subplots : bool

typo

Copy link
Copy Markdown
Contributor

@jreback jreback Feb 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo here, is this checked?

* ``False`` - no subplots will be used
* ``True`` - create a subplot for each group
column : column name or list of names, or vector
Expand Down