From 1c573088b8fffe0843a8dab0058e465b282bf940 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Moron=20Tejero?= <43825325+victormoron@users.noreply.github.com> Date: Fri, 8 Feb 2019 02:49:50 +0000 Subject: [PATCH] DOC: Fixes to docstrings and add PR10 (space before colon) to validation (#25109) --- ci/code_checks.sh | 2 +- pandas/core/config.py | 4 ++-- pandas/io/excel.py | 2 +- pandas/plotting/_core.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 2bd6aa2f9c7a5..d0dea72d69996 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -240,7 +240,7 @@ fi ### DOCSTRINGS ### if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then - MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, EX04, RT04, SS05, SA05)' ; echo $MSG + MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, PR10, EX04, RT04, SS05, SA05)' ; echo $MSG $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR05,EX04,RT04,SS05,SA05 RET=$(($RET + $?)) ; echo $MSG "DONE" diff --git a/pandas/core/config.py b/pandas/core/config.py index 0f43ca65d187a..01664fffb1e27 100644 --- a/pandas/core/config.py +++ b/pandas/core/config.py @@ -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 : object + New value of option. Returns ------- diff --git a/pandas/io/excel.py b/pandas/io/excel.py index 11e5e78fa3e80..9e5e9f4f0d4f6 100644 --- a/pandas/io/excel.py +++ b/pandas/io/excel.py @@ -1003,7 +1003,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 ---------- diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 1790c70a3c8ac..a525b9cff1182 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2548,7 +2548,7 @@ def boxplot_frame_groupby(grouped, subplots=True, column=None, fontsize=None, Parameters ---------- grouped : Grouped DataFrame - subplots : + subplots : bool * ``False`` - no subplots will be used * ``True`` - create a subplot for each group column : column name or list of names, or vector