DOC: Add examples to MultiIndex.slice_locs + note that index.slice requires #17799
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
monotonic ordering
Codecov Report
@@ Coverage Diff @@
## master #17799 +/- ##
==========================================
- Coverage 91.24% 91.2% -0.05%
==========================================
Files 163 163
Lines 49971 49971
==========================================
- Hits 45597 45576 -21
- Misses 4374 4395 +21
Continue to review full report at Codecov.
|
pandas/core/indexes/base.py
Outdated
| @@ -3556,7 +3556,7 @@ def get_slice_bound(self, label, side, kind): | |||
|
|
|||
| def slice_locs(self, start=None, end=None, step=None, kind=None): | |||
| """ | |||
| Compute slice locations for input labels. | |||
| For an ordered index, compute slice locations for input labels. | |||
There was a problem hiding this comment.
Index does not need to be ordered (it's only when there are duplicates that it has to be ordered I think). eg:
In [11]: pd.Index([1, 3, 4, 2]).slice_locs(1, 2)
Out[11]: (0, 4)
There was a problem hiding this comment.
Oh, thanks for catching that. I've reworded.
pandas/core/indexes/multi.py
Outdated
|
|
||
| Examples | ||
| -------- | ||
| mi = pd.MultiIndex.from_arrays([list('abbd'), list('deff')], |
There was a problem hiding this comment.
use
>>>
...
notation for the examples
pandas/core/indexes/multi.py
Outdated
| @@ -2015,6 +2042,8 @@ def get_loc(self, key, method=None): | |||
| See also | |||
| -------- | |||
| Index.get_loc : get_loc method for (single-level) index. | |||
| MultiIndex.slice_locs : Get slice location given startlabel(s) and | |||
There was a problem hiding this comment.
startlabel -> start label
|
Commit added doing the requested changes. |
topper-123
force-pushed
the
MultiIndex.slice_locs
branch
from
c84dd1c to
1e5fd28
Compare
|
@topper-123 Thanks! |
ghost
pushed a commit
to reef-technologies/pandas
that referenced
this pull request
Oct 16, 2017
alanbato
pushed a commit
to alanbato/pandas
that referenced
this pull request
Nov 10, 2017
No-Stream
pushed a commit
to No-Stream/pandas
that referenced
this pull request
Nov 28, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify
.slice_locsand set up examples for how to use the method.Also, for
pd.Indexclarify that using.slice_locsrequires that the index is monotonic.