DOC: fixing PR01 errors for pandas.Categorical and pandas.Categorical…

….__array__ (pandas-dev#57561) * fixing PR01 errors for pandas.Categorical and pandas.Categorical.__array__ * updated dtype to np.dtype Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com> --------- Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
pmhatre1 · May 7, 2024 · dde20f9 · dde20f9
1 parent dd9fda3
commit dde20f9
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -1458,8 +1458,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
 
     MSG='Partially validate docstrings (PR01)' ;  echo $MSG
     $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR01 --ignore_functions \
-        pandas.Categorical\
-        pandas.Categorical.__array__\
         pandas.CategoricalIndex.equals\
         pandas.CategoricalIndex.map\
         pandas.DataFrame.at_time\

diff --git a/pandas/core/arrays/categorical.py b/pandas/core/arrays/categorical.py
@@ -276,6 +276,11 @@ class Categorical(NDArrayBackedExtensionArray, PandasObject, ObjectStringArrayMi
         provided).
     dtype : CategoricalDtype
         An instance of ``CategoricalDtype`` to use for this categorical.
+    fastpath : bool
+        The 'fastpath' keyword in Categorical is deprecated and will be
+        removed in a future version. Use Categorical.from_codes instead.
+    copy : bool, default True
+        Whether to copy if the codes are unchanged.
 
     Attributes
     ----------
@@ -1657,6 +1662,11 @@ def __array__(self, dtype: NpDtype | None = None) -> np.ndarray:
         """
         The numpy array interface.
 
+        Parameters
+        ----------
+        dtype : np.dtype or None
+            Specifies the the dtype for the array.
+
         Returns
         -------
         numpy.array