Doc: Further improvements for IntervalIndex and Interval #17714
Merged
Conversation
This file contains 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
|
Hello @topper-123! Thanks for updating the PR. Cheers ! There are no PEP8 issues in this Pull Request. 🍻 Comment last updated on September 29, 2017 at 12:08 Hours UTC |
topper-123
changed the title
topper-123
force-pushed
the
IntervalIndex_docstring_II
branch
from
1e9f666
to
1a76fca
Compare
Codecov Report
@@ Coverage Diff @@
## master #17714 +/- ##
==========================================
- Coverage 91.27% 91.25% -0.02%
==========================================
Files 163 163
Lines 49765 49783 +18
==========================================
+ Hits 45421 45430 +9
- Misses 4344 4353 +9
Continue to review full report at Codecov.
|
pandas/_libs/interval.pyx
Outdated
| Examples | ||
| -------- | ||
| >>> abc = pd.Interval(left='a', right='c', closed='both') | ||
| >>> 'b' in abc |
There was a problem hiding this comment.
I would also show the abc (so you see the repr)
(and personally I would find a integer (numeric) example better? (more common?))
There was a problem hiding this comment.
Ok, I see that, I've changed it
pandas/core/indexes/interval.py
Outdated
| @@ -105,8 +105,10 @@ class IntervalIndex(IntervalMixin, Index): | |||
|
|
|||
| .. versionadded:: 0.20.0 | |||
|
|
|||
| Warning: the indexing behaviors are provisional and may change in | |||
| a future version of pandas. | |||
| .. Warning:: | |||
There was a problem hiding this comment.
I think it is with a lower case W
topper-123
force-pushed
the
IntervalIndex_docstring_II
branch
from
1a76fca
to
6fd0700
Compare
jreback
requested changes
Sep 29, 2017
pandas/_libs/interval.pyx
Outdated
| >>> pd.Timestamp('2017-01-01 00:00') in year_2017 | ||
| True | ||
|
|
||
| Note |
There was a problem hiding this comment.
this doesn't actually belong here. Yes its useful info but we can't possibly list all these kinds of references, nor do we, the See Also is enough.
There was a problem hiding this comment.
It's been removed.
topper-123
force-pushed
the
IntervalIndex_docstring_II
branch
from
6fd0700
to
0e27cd4
Compare
jreback
approved these changes
Sep 29, 2017
|
lgtm. ping on green. |
|
ping @jreback at green (I assume the failure in CircleCI has nothin to do with my PR). |
|
I've been seeing this compilation error fairly regularly: I'll open a separate issue to track it. |
ghost
pushed a commit
to reef-technologies/pandas
that referenced
this pull request
Oct 2, 2017
* 'master' of github.com:pandas-dev/pandas: (188 commits) Separate out _convert_datetime_to_tsobject (pandas-dev#17715) DOC: remove whatsnew note for xref pandas-dev#17131 BUG: Regression in .loc accepting a boolean Index as an indexer (pandas-dev#17738) DEPR: Deprecate cdate_range and merge into bdate_range (pandas-dev#17691) CLN: replace %s syntax with .format in pandas.core: categorical, common, config, config_init (pandas-dev#17735) Fixed the memory usage explanation of categorical in gotchas from O(nm) to O(n+m) (pandas-dev#17736) TST: add backward compat for offset testing for pickles (pandas-dev#17733) remove unused time conversion funcs (pandas-dev#17711) DEPR: Deprecate convert parameter in take (pandas-dev#17352) BUG:Time Grouper bug fix when applied for list groupers (pandas-dev#17587) BUG: Fix some PeriodIndex resampling issues (pandas-dev#16153) BUG: Fix unexpected sort in groupby (pandas-dev#17621) DOC: Fixed typo in documentation for 'pandas.DataFrame.replace' (pandas-dev#17731) BUG: Fix series rename called with str altering name rather index (GH17407) (pandas-dev#17654) DOC: Add examples for MultiIndex.get_locs + cleanups (pandas-dev#17675) Doc improvements for IntervalIndex and Interval (pandas-dev#17714) BUG: DataFrame sort_values and multiple "by" columns fails to order NaT correctly Last of the timezones funcs (pandas-dev#17669) Add missing file to _pyxfiles, delete commented-out (pandas-dev#17712) update imports of DateParseError, remove unused imports from tslib (pandas-dev#17713) ...
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.
git diff upstream/master -u -- "*.py" | flake8 --diffThis follows #17706. Further changes are:
IntervalIndexandInterval.IntervalIntervalIndexis now parsed properly.from_*metods into one line.cutandqcutto 'See also'This will conclude my contributions to
IntervalIndex.