Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Index.get_indexer_for #58507

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

DOC: Enforce Numpy Docstring Validation for pandas.Index.get_indexer_for #58507

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
e9d5115
DOC: add PR01,SA01 in pandas.Index.get_indexer_for
tuhinsharma121 May 1, 2024
ddd927f
DOC: remove PR01,SA01 in pandas.Index.get_indexer_for
tuhinsharma121 May 1, 2024
ecd3531
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 @@ -84,7 +84,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_for PR01,SA01" \
-i "pandas.Index.get_loc PR07,RT03,SA01" \
-i "pandas.Index.join PR07,RT03,SA01" \
-i "pandas.Index.names GL08" \
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 @@ -5953,11 +5953,23 @@ def get_indexer_for(self, target) -> npt.NDArray[np.intp]:
This dispatches to get_indexer or get_indexer_non_unique
as appropriate.

Parameters
----------
target : Index
An iterable containing the values to be used for computing indexer.

Returns
-------
np.ndarray[np.intp]
List of indices.

See Also
--------
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.

Examples
--------
>>> idx = pd.Index([np.nan, "var1", np.nan])
Expand Down