Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Index.get_loc #58509

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
May 1, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.get_loc #58509

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
55f1947
DOC: add PR07,RT03,SA01 in pandas.Index.get_loc
tuhinsharma121 May 1, 2024
524c109
DOC: remove PR07,RT03,SA01 in pandas.Index.get_loc
tuhinsharma121 May 1, 2024
5f0244a
DOC: resolve merge conflict
tuhinsharma121 May 1, 2024
05b7a2e
DOC: resolve merge conflict
tuhinsharma121 May 1, 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 @@ -83,7 +83,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DataFrame.var PR01,RT03,SA01" \
-i "pandas.Grouper PR02" \
-i "pandas.Index PR07" \
-i "pandas.Index.get_loc PR07,RT03,SA01" \
-i "pandas.Index.join PR07,RT03,SA01" \
-i "pandas.Index.names GL08" \
-i "pandas.Index.ravel PR01,RT03" \
Expand Down
12 changes: 12 additions & 0 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3490,10 +3490,22 @@ def get_loc(self, key):
Parameters
----------
key : label
The key to check its location if it is present in the index.

Returns
-------
int if unique index, slice if monotonic index, else mask
Integer location, slice or boolean mask.

See Also
--------
Index.get_slice_bound : Calculate slice bound that corresponds to
given label.
Index.get_indexer : Computes indexer and mask for new index given
the current index.
Index.get_non_unique : Returns indexer and masks for new index given
the current index.
Index.get_indexer_for : Returns an indexer even when non-unique.

Examples
--------
Expand Down