Skip to content

DOC: IntervalArray and IntervalIndex minor doc fixes #24780

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.

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 1 commit into from
Jan 15, 2019

Conversation

jschendel
Copy link
Member

@jschendel jschendel commented Jan 15, 2019

Some minor fixes for things that aren't rendering correctly for IntervalArray and IntervalIndex. I've built the docs locally and the changes look good.

For IntervalArray :

  • IntervalArray.values doesn't exist, so removing it.

image

For IntervalIndex:

  • IntervalIndex.is_non_overlapping_monotonic lost it's docstring, so adding it back via shared docs
  • IntervalIndex.to_tuples isn't being generated, so now generating it. Also fixed versionadded directive.

image

@jschendel jschendel added Docs Interval Interval data type labels Jan 15, 2019
@jschendel jschendel added this to the 0.24.0 milestone Jan 15, 2019
@codecov
Copy link

codecov bot commented Jan 15, 2019

Codecov Report

Merging #24780 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24780      +/-   ##
==========================================
+ Coverage   92.38%   92.38%   +<.01%     
==========================================
  Files         166      166              
  Lines       52363    52366       +3     
==========================================
+ Hits        48377    48380       +3     
  Misses       3986     3986
Flag Coverage Δ
#multiple 90.81% <100%> (ø) ⬆️
#single 42.91% <100%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/arrays/interval.py 93.12% <100%> (+0.03%) ⬆️
pandas/core/indexes/interval.py 95.27% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d3565a...6af067b. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Jan 15, 2019

Codecov Report

Merging #24780 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24780      +/-   ##
==========================================
+ Coverage   92.38%   92.38%   +<.01%     
==========================================
  Files         166      166              
  Lines       52363    52366       +3     
==========================================
+ Hits        48377    48380       +3     
  Misses       3986     3986
Flag Coverage Δ
#multiple 90.81% <100%> (ø) ⬆️
#single 42.91% <100%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/arrays/interval.py 93.12% <100%> (+0.03%) ⬆️
pandas/core/indexes/interval.py 95.27% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d3565a...6af067b. Read the comment docs.

@jreback jreback merged commit 56d809e into pandas-dev:master Jan 15, 2019
@jreback
Copy link
Contributor

jreback commented Jan 15, 2019

thanks

@jschendel jschendel deleted the interval-docs branch January 15, 2019 15:55
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Interval Interval data type
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants