Fix PR10 error and Clean up docstrings from functions related to RT05 errors

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, RT04, SS05)' ; echo $MSG
-    $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR05,EX04,RT04,SS05
+    MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, EX04, RT04, RT05, SS05)' ; echo $MSG
+    $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR05,EX04,RT04,RT05,SS05
     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.\n
+        If the input is a Categorical dtype, the return is a Categorical.\n
+        If the input is a Series/ndarray, the return will be an ndarray.
 
     See Also
     --------

pandas/core/arrays/categorical.py

@@ -1292,7 +1292,7 @@ def __array__(self, dtype=None):
         values : numpy array
             A numpy array of either the specified dtype or,
             if dtype==None (default), the same dtype as
-            categorical.categories.dtype
+            categorical.categories.dtype .
         """
         ret = take_1d(self.categories.values, self._codes)
         if dtype and not is_dtype_equal(dtype, self.categories.dtype):
@@ -1501,7 +1501,7 @@ def get_values(self):
         -------
         values : numpy array
             A numpy array of the same dtype as categorical.categories.dtype or
-            Index if datetime / periods
+            Index if datetime / periods.
         """
         # if we are a datetime and period index, return Index to keep metadata
         if is_datetimelike(self.categories):

pandas/core/arrays/datetimelike.py

@@ -144,7 +144,7 @@ def strftime(self, date_format):
         Return an Index of formatted strings specified by date_format, which
         supports the same string format as the python standard library. Details
         of the string format can be found in `python string format
-        doc <%(URL)s>`__
+        doc <%(URL)s>`__ .
 
         Parameters
         ----------
@@ -154,7 +154,7 @@ def strftime(self, date_format):
         Returns
         -------
         Index
-            Index of formatted strings
+            Index of formatted strings.
 
         See Also
         --------
@@ -748,7 +748,7 @@ def _maybe_mask_results(self, result, fill_value=iNaT, convert=None):
         mask the result if needed, convert to the provided dtype if its not
         None
 
-        This is an internal routine
+        This is an internal routine.
         """
 
         if self._hasnans:
@@ -1047,7 +1047,7 @@ def _sub_period_array(self, other):
         Returns
         -------
         result : np.ndarray[object]
-            Array of DateOffset objects; nulls represented by NaT
+            Array of DateOffset objects; nulls represented by NaT.
         """
         if not is_period_dtype(self):
             raise TypeError("cannot subtract {dtype}-dtype from {cls}"

pandas/core/frame.py

@@ -2797,7 +2797,7 @@ def set_value(self, index, col, value, takeable=False):
         -------
         frame : DataFrame
             If label pair is contained, will be reference to calling DataFrame,
-            otherwise a new object
+            otherwise a new object.
         """
         warnings.warn("set_value is deprecated and will be removed "
                       "in a future release. Please use "

pandas/core/generic.py

@@ -4951,10 +4951,11 @@ 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.\n
+        If DataFrame.agg is called with several functions, returns
+        a DataFrame.\n
+        If Series.agg is called with single function, returns a scalar.\n
+        If Series.agg is called with several functions, returns a Series.
 
     %(see_also)s
 
@@ -5350,7 +5351,7 @@ def get_values(self):
         Returns
         -------
         numpy.ndarray
-            Numpy representation of DataFrame
+            Numpy representation of DataFrame.
 
         See Also
         --------
@@ -5429,7 +5430,7 @@ def get_ftype_counts(self):
         -------
         dtype : Series
             Series with the count of columns with each type and
-            sparsity (dense/sparse)
+            sparsity (dense/sparse).
 
         See Also
         --------
@@ -6658,7 +6659,7 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None,
         -------
         Series or DataFrame
             Returns the same object type as the caller, interpolated at
-            some or all ``NaN`` values
+            some or all ``NaN`` values.
 
         See Also
         --------
@@ -6882,7 +6883,7 @@ def asof(self, where, subset=None):
            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
-             array-like
+             array-like.
 
         See Also
         --------
@@ -7236,7 +7237,7 @@ def clip(self, lower=None, upper=None, axis=None, inplace=False,
         -------
         Series or DataFrame
             Same type as calling object with the values outside the
-            clip boundaries replaced
+            clip boundaries replaced.
 
         Examples
         --------
@@ -8387,7 +8388,7 @@ def ranker(data):
         Returns
         -------
         (left, right) : (%(klass)s, type of other)
-            Aligned objects
+            Aligned objects.
         """)
 
     @Appender(_shared_docs['align'] % _shared_doc_kwargs)

pandas/core/indexes/base.py

@@ -1556,11 +1556,11 @@ def droplevel(self, level=0):
         Returns
         -------
         grouper : Index
-            Index of values to group on
+            Index of values to group on.
         labels : ndarray of int or None
-            Array of locations in level_index
+            Array of locations in level_index.
         uniques : Index or None
-            Index of unique values for level
+            Index of unique values for level.
         """
 
     @Appender(_index_shared_docs['_get_grouper_for_level'])
@@ -1828,7 +1828,7 @@ def isna(self):
         Returns
         -------
         numpy.ndarray
-            A boolean array of whether my values are NA
+            A boolean array of whether my values are NA.
 
         See Also
         --------
@@ -2972,7 +2972,7 @@ def _convert_listlike_indexer(self, keyarr, kind=None):
         -------
         tuple (indexer, keyarr)
             indexer is an ndarray or None if cannot convert
-            keyarr are tuple-safe keys
+            keyarr are tuple-safe keys.
         """
         if isinstance(keyarr, Index):
             keyarr = self._convert_index_indexer(keyarr)
@@ -3098,9 +3098,9 @@ def reindex(self, target, method=None, level=None, limit=None,
         Returns
         -------
         new_index : pd.Index
-            Resulting index
+            Resulting index.
         indexer : np.ndarray or None
-            Indices of output values in original index
+            Indices of output values in original index.
 
         """
         # GH6552: preserve names when reindexing to non-named target
@@ -3156,9 +3156,9 @@ def _reindex_non_unique(self, target):
         Returns
         -------
         new_index : pd.Index
-            Resulting index
+            Resulting index.
         indexer : np.ndarray or None
-            Indices of output values in original index
+            Indices of output values in original index.
 
         """
 
@@ -4259,7 +4259,7 @@ def shift(self, periods=1, freq=None):
         Returns
         -------
         pandas.Index
-            Shifted index
+            Shifted index.
 
         See Also
         --------
@@ -4422,7 +4422,7 @@ def set_value(self, arr, key, value):
             in the target are marked by -1.
         missing : ndarray of int
             An indexer into the target of the values not found.
-            These correspond to the -1 in the indexer array
+            These correspond to the -1 in the indexer array.
         """
 
     @Appender(_index_shared_docs['get_indexer_non_unique'] % _index_doc_kwargs)

pandas/core/indexes/multi.py

@@ -61,7 +61,7 @@ def _codes_to_ints(self, codes):
         Returns
         ------
         int_keys : scalar or 1-dimensional array, of dtype uint64
-            Integer(s) representing one combination (each)
+            Integer(s) representing one combination (each).
         """
         # Shift the representation of each level by the pre-calculated number
         # of bits:
@@ -101,7 +101,7 @@ def _codes_to_ints(self, codes):
         Returns
         ------
         int_keys : int, or 1-dimensional array of dtype object
-            Integer(s) representing one combination (each)
+            Integer(s) representing one combination (each).
         """
 
         # Shift the representation of each level by the pre-calculated number
@@ -1956,7 +1956,7 @@ def swaplevel(self, i=-2, j=-1):
         Returns
         -------
         MultiIndex
-            A new MultiIndex
+            A new MultiIndex.
 
         .. versionchanged:: 0.18.1
 
@@ -2053,9 +2053,9 @@ def sortlevel(self, level=0, ascending=True, sort_remaining=True):
         Returns
         -------
         sorted_index : pd.MultiIndex
-            Resulting index
+            Resulting index.
         indexer : np.ndarray
-            Indices of output values in original index
+            Indices of output values in original index.
         """
         from pandas.core.sorting import indexer_from_factorized
 
@@ -2189,7 +2189,7 @@ def reindex(self, target, method=None, level=None, limit=None,
         new_index : pd.MultiIndex
             Resulting index
         indexer : np.ndarray or None
-            Indices of output values in original index
+            Indices of output values in original index.
 
         """
         # GH6552: preserve names when reindexing to non-named target

pandas/core/panel.py

@@ -539,7 +539,7 @@ def set_value(self, *args, **kwargs):
         -------
         panel : Panel
             If label combo is contained, will be reference to calling Panel,
-            otherwise a new object
+            otherwise a new object.
         """
         warnings.warn("set_value is deprecated and will be removed "
                       "in a future release. Please use "
@@ -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/reshape/melt.py

@@ -230,7 +230,7 @@ def wide_to_long(df, stubnames, i, j, sep="", suffix=r'\d+'):
     -------
     DataFrame
         A DataFrame that contains each stub name as a variable, with new index
-        (i, j)
+        (i, j).
 
     Notes
     -----

pandas/core/series.py

@@ -1209,7 +1209,7 @@ def set_value(self, label, value, takeable=False):
         -------
         series : Series
             If label is contained, will be reference to calling Series,
-            otherwise a new object
+            otherwise a new object.
         """
         warnings.warn("set_value is deprecated and will be removed "
                       "in a future release. Please use "
@@ -1629,7 +1629,7 @@ def unique(self):
             * Datetime with Timezone
             * Interval
             * Sparse
-            * IntegerNA
+            * IntegerNA .
 
         See Also
         --------

pandas/core/tools/numeric.py

@@ -59,7 +59,7 @@ def to_numeric(arg, errors='raise', downcast=None):
     Returns
     -------
     ret : numeric if parsing succeeded.
-        Return type depends on input.  Series if Series, otherwise ndarray
+        Return type depends on input.  Series if Series, otherwise ndarray.
 
     See Also
     --------

pandas/core/window.py

@@ -1271,7 +1271,7 @@ def skew(self, **kwargs):
     -------
     Series or DataFrame
         Returned object type is determined by the caller of the %(name)s
-        calculation
+        calculation.
 
     See Also
     --------

pandas/io/formats/style.py

@@ -433,7 +433,7 @@ def render(self, **kwargs):
         Returns
         -------
         rendered : str
-            The rendered HTML
+            The rendered HTML.
 
         Notes
         -----