Skip to content

Commit 1fa0317

Browse files
tuhinsharma121NME104
authored andcommitted
DOC: Enforce Numpy Docstring Validation for pandas.Index.item (pandas-dev#58400)
* DOC: add SA01 to pandas.Index.item * DOC: remove pandas.Index.item * DOC: remove pandas.Series.item --------- Co-authored-by: aBiR1D <[email protected]>
1 parent e7e2f1c commit 1fa0317

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
134134
-i "pandas.Index.inferred_type SA01" \
135135
-i "pandas.Index.insert PR07,RT03,SA01" \
136136
-i "pandas.Index.intersection PR07,RT03,SA01" \
137-
-i "pandas.Index.item SA01" \
138137
-i "pandas.Index.join PR07,RT03,SA01" \
139138
-i "pandas.Index.memory_usage RT03" \
140139
-i "pandas.Index.names GL08" \
@@ -288,7 +287,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
288287
-i "pandas.Series.is_monotonic_decreasing SA01" \
289288
-i "pandas.Series.is_monotonic_increasing SA01" \
290289
-i "pandas.Series.is_unique SA01" \
291-
-i "pandas.Series.item SA01" \
292290
-i "pandas.Series.kurt RT03,SA01" \
293291
-i "pandas.Series.kurtosis RT03,SA01" \
294292
-i "pandas.Series.le PR07,SA01" \

pandas/core/base.py

+5
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,11 @@ def item(self):
398398
ValueError
399399
If the data is not length = 1.
400400
401+
See Also
402+
--------
403+
Index.values : Returns an array representing the data in the Index.
404+
Series.head : Returns the first `n` rows.
405+
401406
Examples
402407
--------
403408
>>> s = pd.Series([1])

0 commit comments

Comments
 (0)