Skip to content

DOC: Improve code example for Index.get_indexer #21511

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 2 commits into from
Jun 19, 2018
Merged

DOC: Improve code example for Index.get_indexer #21511

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2e6f39
Improve example for Index.get_indexer
Jun 16, 2018
64b87e7
small edits
jorisvandenbossche Jun 19, 2018
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
15 changes: 10 additions & 5 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3146,17 +3146,22 @@ def droplevel(self, level=0):

.. versionadded:: 0.21.0 (list-like tolerance)

Examples
--------
>>> indexer = index.get_indexer(new_index)
>>> new_values = cur_values.take(indexer)

Returns
-------
indexer : ndarray of int
Integers from 0 to n - 1 indicating that the index at these
positions matches the corresponding target values. Missing values
in the target are marked by -1.

Examples
--------
>>> index = pd.Index(['c', 'a', 'b'])
>>> index.get_indexer(['a', 'b', 'x'])
array([ 1, 2, -1])

Notice that the return value is an array of locations in ``index``
and ``x`` is marked by -1, as it is not in ``index``.

"""

@Appender(_index_shared_docs['get_indexer'] % _index_doc_kwargs)
Expand Down