Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Index.get_indexer #58506

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_indexer #58506

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
aa080e5
DOC: add PR07,SA01 in pandas.Index.get_indexer
tuhinsharma121 May 1, 2024
db6cf69
DOC: remove PR07,SA01 in pandas.Index.get_indexer
tuhinsharma121 May 1, 2024
814ae57
DOC: remove PR07,SA01 in pandas.IntervalIndex.get_indexer
tuhinsharma121 May 1, 2024
ffcfb53
DOC: remove PR07,SA01 in pandas.MultiIndex.get_indexer
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
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,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_indexer PR07,SA01" \
-i "pandas.Index.get_indexer_for PR01,SA01" \
-i "pandas.Index.get_indexer_non_unique PR07,SA01" \
-i "pandas.Index.get_loc PR07,RT03,SA01" \
Expand All @@ -109,7 +108,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.IntervalDtype.subtype SA01" \
-i "pandas.IntervalIndex.closed SA01" \
-i "pandas.IntervalIndex.contains RT03" \
-i "pandas.IntervalIndex.get_indexer PR07,SA01" \
-i "pandas.IntervalIndex.get_loc PR07,RT03,SA01" \
-i "pandas.IntervalIndex.is_non_overlapping_monotonic SA01" \
-i "pandas.IntervalIndex.left GL08" \
Expand All @@ -123,7 +121,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.MultiIndex.copy PR07,RT03,SA01" \
-i "pandas.MultiIndex.drop PR07,RT03,SA01" \
-i "pandas.MultiIndex.dtypes SA01" \
-i "pandas.MultiIndex.get_indexer PR07,SA01" \
-i "pandas.MultiIndex.get_level_values SA01" \
-i "pandas.MultiIndex.get_loc PR07" \
-i "pandas.MultiIndex.get_loc_level PR07" \
Expand Down
7 changes: 7 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 @@ -3543,6 +3543,7 @@ def get_indexer(
Parameters
----------
target : Index
An iterable containing the values to be used for computing indexer.
method : {None, 'pad'/'ffill', 'backfill'/'bfill', 'nearest'}, optional
* default: exact matches only.
* pad / ffill: find the PREVIOUS index value if no exact match.
Expand Down Expand Up @@ -3570,6 +3571,12 @@ def get_indexer(
positions matches the corresponding target values. Missing values
in the target are marked by -1.

See Also
--------
Index.get_indexer_for : Returns an indexer even when non-unique.
Index.get_non_unique : Returns indexer and masks for new index given
the current index.

Notes
-----
Returns -1 for unmatched values, for further explanation see the
Expand Down