DOC: Fixes to docstrings and add PR10 (space before colon) to validat…

…ion (pandas-dev#25109)
Pingviinituutti · Feb 28, 2019 · 5fc4c39 · 5fc4c39
1 parent 904401f
commit 5fc4c39
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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
@@ -2550,7 +2550,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