Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Index.sliece_indexer #58490

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 3 commits into from
Apr 30, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.sliece_indexer #58490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7c0bf4
DOC: add PR07,RT03 in pandas.Index.slice_indexer
tuhinsharma121 Apr 30, 2024
8f812d0
DOC: add SA01 in pandas.Index.slice_indexer
tuhinsharma121 Apr 30, 2024
85110e7
DOC: remove pandas.Index.slice_indexer
tuhinsharma121 Apr 30, 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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Index.names GL08" \
-i "pandas.Index.putmask PR01,RT03" \
-i "pandas.Index.ravel PR01,RT03" \
-i "pandas.Index.slice_indexer PR07,RT03,SA01" \
-i "pandas.Index.str PR01,SA01" \
-i "pandas.Index.take PR01,PR07" \
-i "pandas.Index.view GL08" \
Expand Down
9 changes: 8 additions & 1 deletion pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6330,19 +6330,26 @@ def slice_indexer(
end : label, default None
If None, defaults to the end.
step : int, default None
If None, defaults to 1.

Returns
-------
slice
A slice object.

Raises
------
KeyError : If key does not exist, or key is not unique and index is
not ordered.

See Also
--------
Index.slice_locs : Computes slice locations for input labels.
Index.get_slice_bound : Retrieves slice bound that corresponds to given label.

Notes
-----
This function assumes that the data is sorted, so use at your own peril
This function assumes that the data is sorted, so use at your own peril.

Examples
--------
Expand Down