Skip to content

Commit 0c4799b

Browse files
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
1 parent 8330de2 commit 0c4799b

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7777
-i "pandas.DataFrame.plot PR02,SA01" \
7878
-i "pandas.Grouper PR02" \
7979
-i "pandas.Index PR07" \
80-
-i "pandas.Index.ravel PR01,RT03" \
8180
-i "pandas.Interval PR02" \
8281
-i "pandas.IntervalIndex.closed SA01" \
8382
-i "pandas.IntervalIndex.contains RT03" \

pandas/core/indexes/base.py

+7
Original file line numberDiff line numberDiff line change
@@ -996,9 +996,16 @@ def ravel(self, order: str_t = "C") -> Self:
996996
"""
997997
Return a view on self.
998998
999+
Parameters
1000+
----------
1001+
order : {'K', 'A', 'C', 'F'}, default 'C'
1002+
Specify the memory layout of the view. This parameter is not
1003+
implemented currently.
1004+
9991005
Returns
10001006
-------
10011007
Index
1008+
A view on self.
10021009
10031010
See Also
10041011
--------

0 commit comments

Comments
 (0)