DOC: Enforce Numpy Docstring Validation for pandas.Index.ravel (#58561)

* DOC: add PR01,RT03 for pandas.Index.ravel * DOC: remove PR01,RT03 for pandas.Index.ravel
pandas-dev · May 6, 2024 · 0c4799b · 0c4799b
1 parent 8330de2
commit 0c4799b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -77,7 +77,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.DataFrame.plot PR02,SA01" \
         -i "pandas.Grouper PR02" \
         -i "pandas.Index PR07" \
-        -i "pandas.Index.ravel PR01,RT03" \
         -i "pandas.Interval PR02" \
         -i "pandas.IntervalIndex.closed SA01" \
         -i "pandas.IntervalIndex.contains RT03" \

diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py
@@ -996,9 +996,16 @@ def ravel(self, order: str_t = "C") -> Self:
         """
         Return a view on self.
 
+        Parameters
+        ----------
+        order : {'K', 'A', 'C', 'F'}, default 'C'
+            Specify the memory layout of the view. This parameter is not
+            implemented currently.
+
         Returns
         -------
         Index
+            A view on self.
 
         See Also
         --------