Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Index.item #58400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 25, 2024
+5 −2
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.item #58400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6d1fc97
DOC: add SA01 to pandas.Index.item
tuhinsharma121 Apr 24, 2024
b40fd83
DOC: remove pandas.Index.item
tuhinsharma121 Apr 24, 2024
2a01ddf
DOC: remove pandas.Series.item
tuhinsharma121 Apr 24, 2024
461b803
Merge remote-tracking branch 'upstream/main' into numpy-docstring-ind…
tuhinsharma121 Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Index.inferred_type SA01" \
-i "pandas.Index.insert PR07,RT03,SA01" \
-i "pandas.Index.intersection PR07,RT03,SA01" \
-i "pandas.Index.item SA01" \
-i "pandas.Index.join PR07,RT03,SA01" \
-i "pandas.Index.memory_usage RT03" \
-i "pandas.Index.names GL08" \
Expand Down Expand Up @@ -288,7 +287,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.is_monotonic_decreasing SA01" \
-i "pandas.Series.is_monotonic_increasing SA01" \
-i "pandas.Series.is_unique SA01" \
-i "pandas.Series.item SA01" \
-i "pandas.Series.kurt RT03,SA01" \
-i "pandas.Series.kurtosis RT03,SA01" \
-i "pandas.Series.le PR07,SA01" \
Expand Down
5 changes: 5 additions & 0 deletions pandas/core/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,11 @@ def item(self):
ValueError
If the data is not length = 1.

See Also
--------
Index.values : Returns an array representing the data in the Index.
Series.head : Returns the first `n` rows.

Examples
--------
>>> s = pd.Series([1])
Expand Down