DOC: tweak paragraph regarding cut and IntervalIndex #27132
Merged
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
WillAyd
requested changes
Jun 30, 2019
doc/source/user_guide/advanced.rst
Outdated
|
|
||
| .. ipython:: python | ||
|
|
||
| c = pd.cut(range(4), bins=2) | ||
| c | ||
| c.categories | ||
|
|
||
| Furthermore, ``IntervalIndex`` allows one to bin *other* data with these same | ||
| bins, with ``NaN`` representing a missing value similar to other dtypes. | ||
| :func:`cut` also accepts an ``IntervalIndex`` for its `bins` argument, which enables |
There was a problem hiding this comment.
Double backticks for anything that is not a role here
doc/source/user_guide/advanced.rst
Outdated
|
|
||
| .. ipython:: python | ||
|
|
||
| pd.cut([0, 3, 5, 1], bins=c.categories) | ||
|
|
||
| When :func:`cut` is passed an ``IntervalIndex`` for the `bins` argument, The ``Interval`` | ||
| values in the ``IntervalIndex`` define the bins and any value which falls outside all | ||
| bins will be assigned a ``NaN`` value. |
There was a problem hiding this comment.
I would keep it to the last part here (the former is already explained before the example), like "Values that fall outside the passed Intervals will be assigned a NaN value".
added 2 commits
June 30, 2019 23:55
jorisvandenbossche
approved these changes
Jun 30, 2019
|
@pilkibun Thanks! |
ghost
deleted the
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.
I thought this paragraph could be improved, so I tried to.