DOC: Fix validation type error RT04 (#25107) (#25129)

Author: MarckK

ci/code_checks.sh

@@ -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, EX04, RT04)' ; echo $MSG
+    $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR05,EX04,RT04
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
 fi

pandas/core/algorithms.py

@@ -289,9 +289,9 @@ def unique(values):
     Returns
     -------
     unique values.
-      - If the input is an Index, the return is an Index
-      - If the input is a Categorical dtype, the return is a Categorical
-      - If the input is a Series/ndarray, the return will be an ndarray
+      If the input is an Index, the return is an Index
+      If the input is a Categorical dtype, the return is a Categorical
+      If the input is a Series/ndarray, the return will be an ndarray
 
     See Also
     --------

pandas/core/dtypes/common.py

@@ -7767,10 +7767,10 @@ def quantile(self, q=0.5, axis=0, numeric_only=True,
         -------
         quantiles : Series or DataFrame
 
-            - If ``q`` is an array, a DataFrame will be returned where the
+            If ``q`` is an array, a DataFrame will be returned where the
               index is ``q``, the columns are the columns of self, and the
               values are the quantiles.
-            - If ``q`` is a float, a Series will be returned where the
+            If ``q`` is a float, a Series will be returned where the
               index is the columns of self and the values are the quantiles.
 
         See Also

pandas/core/frame.py

@@ -4951,10 +4951,10 @@ def pipe(self, func, *args, **kwargs):
     Returns
     -------
     DataFrame, Series or scalar
-        if DataFrame.agg is called with a single function, returns a Series
-        if DataFrame.agg is called with several functions, returns a DataFrame
-        if Series.agg is called with single function, returns a scalar
-        if Series.agg is called with several functions, returns a Series
+        If DataFrame.agg is called with a single function, returns a Series
+        If DataFrame.agg is called with several functions, returns a DataFrame
+        If Series.agg is called with single function, returns a scalar
+        If Series.agg is called with several functions, returns a Series
 
     %(see_also)s
 
@@ -6878,10 +6878,10 @@ def asof(self, where, subset=None):
         -------
         scalar, Series, or DataFrame
 
-           * scalar : when `self` is a Series and `where` is a scalar
-           * Series: when `self` is a Series and `where` is an array-like,
+           Scalar : when `self` is a Series and `where` is a scalar
+           Series: when `self` is a Series and `where` is an array-like,
              or when `self` is a DataFrame and `where` is a scalar
-           * DataFrame : when `self` is a DataFrame and `where` is an
+           DataFrame : when `self` is a DataFrame and `where` is an
              array-like
 
         See Also

pandas/core/generic.py

@@ -140,7 +140,7 @@ def to_pydatetime(self):
         Returns
         -------
         numpy.ndarray
-            object dtype array containing native Python datetime objects.
+            Object dtype array containing native Python datetime objects.
 
         See Also
         --------
@@ -208,7 +208,7 @@ def to_pytimedelta(self):
         Returns
         -------
         a : numpy.ndarray
-            1D array containing data with `datetime.timedelta` type.
+            Array of 1D containing data with `datetime.timedelta` type.
 
         See Also
         --------

pandas/core/indexes/accessors.py

@@ -4259,7 +4259,7 @@ def shift(self, periods=1, freq=None):
         Returns
         -------
         pandas.Index
-            shifted index
+            Shifted index
 
         See Also
         --------

pandas/core/indexes/base.py

@@ -1391,7 +1391,7 @@ def get_level_values(self, level):
         Returns
         -------
         values : Index
-            ``values`` is a level of this MultiIndex converted to
+            Values is a level of this MultiIndex converted to
             a single :class:`Index` (or subclass thereof).
 
         Examples

pandas/core/indexes/multi.py

@@ -802,7 +802,7 @@ def major_xs(self, key):
         Returns
         -------
         y : DataFrame
-            index -> minor axis, columns -> items
+            Index -> minor axis, columns -> items
 
         Notes
         -----
@@ -826,7 +826,7 @@ def minor_xs(self, key):
         Returns
         -------
         y : DataFrame
-            index -> major axis, columns -> items
+            Index -> major axis, columns -> items
 
         Notes
         -----

pandas/core/panel.py

@@ -2025,7 +2025,7 @@ def quantile(self, q=0.5, interpolation='linear'):
         Returns
         -------
         quantile : float or Series
-            if ``q`` is an array, a Series will be returned where the
+            If ``q`` is an array, a Series will be returned where the
             index is ``q`` and the values are the quantiles.
 
         See Also

pandas/core/series.py

@@ -433,7 +433,7 @@ def render(self, **kwargs):
         Returns
         -------
         rendered : str
-            the rendered HTML
+            The rendered HTML
 
         Notes
         -----
@@ -1223,7 +1223,7 @@ def from_custom_template(cls, searchpath, name):
         Returns
         -------
         MyStyler : subclass of Styler
-            has the correct ``env`` and ``template`` class attributes set.
+            Has the correct ``env`` and ``template`` class attributes set.
         """
         loader = ChoiceLoader([
             FileSystemLoader(searchpath),