Skip to content

Commit b804d9e

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.Index.get_indexer (#58506)
* DOC: add PR07,SA01 in pandas.Index.get_indexer * DOC: remove PR07,SA01 in pandas.Index.get_indexer * DOC: remove PR07,SA01 in pandas.IntervalIndex.get_indexer * DOC: remove PR07,SA01 in pandas.MultiIndex.get_indexer
1 parent 59f6a33 commit b804d9e

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

ci/code_checks.sh

-3
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8787
-i "pandas.DataFrame.var PR01,RT03,SA01" \
8888
-i "pandas.Grouper PR02" \
8989
-i "pandas.Index PR07" \
90-
-i "pandas.Index.get_indexer PR07,SA01" \
9190
-i "pandas.Index.get_indexer_for PR01,SA01" \
9291
-i "pandas.Index.get_indexer_non_unique PR07,SA01" \
9392
-i "pandas.Index.get_loc PR07,RT03,SA01" \
@@ -109,7 +108,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
109108
-i "pandas.IntervalDtype.subtype SA01" \
110109
-i "pandas.IntervalIndex.closed SA01" \
111110
-i "pandas.IntervalIndex.contains RT03" \
112-
-i "pandas.IntervalIndex.get_indexer PR07,SA01" \
113111
-i "pandas.IntervalIndex.get_loc PR07,RT03,SA01" \
114112
-i "pandas.IntervalIndex.is_non_overlapping_monotonic SA01" \
115113
-i "pandas.IntervalIndex.left GL08" \
@@ -123,7 +121,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
123121
-i "pandas.MultiIndex.copy PR07,RT03,SA01" \
124122
-i "pandas.MultiIndex.drop PR07,RT03,SA01" \
125123
-i "pandas.MultiIndex.dtypes SA01" \
126-
-i "pandas.MultiIndex.get_indexer PR07,SA01" \
127124
-i "pandas.MultiIndex.get_level_values SA01" \
128125
-i "pandas.MultiIndex.get_loc PR07" \
129126
-i "pandas.MultiIndex.get_loc_level PR07" \

pandas/core/indexes/base.py

+7
Original file line numberDiff line numberDiff line change
@@ -3543,6 +3543,7 @@ def get_indexer(
35433543
Parameters
35443544
----------
35453545
target : Index
3546+
An iterable containing the values to be used for computing indexer.
35463547
method : {None, 'pad'/'ffill', 'backfill'/'bfill', 'nearest'}, optional
35473548
* default: exact matches only.
35483549
* pad / ffill: find the PREVIOUS index value if no exact match.
@@ -3570,6 +3571,12 @@ def get_indexer(
35703571
positions matches the corresponding target values. Missing values
35713572
in the target are marked by -1.
35723573
3574+
See Also
3575+
--------
3576+
Index.get_indexer_for : Returns an indexer even when non-unique.
3577+
Index.get_non_unique : Returns indexer and masks for new index given
3578+
the current index.
3579+
35733580
Notes
35743581
-----
35753582
Returns -1 for unmatched values, for further explanation see the

0 commit comments

Comments
 (0)