Skip to content

DOC: whatsnew 0.24.0 corrections & edits & remove some warnings #24298

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 4 commits into from
Dec 17, 2018

Conversation

jreback
Copy link
Contributor

@jreback jreback commented Dec 15, 2018

No description provided.

@jreback jreback added the Docs label Dec 15, 2018
@jreback jreback added this to the 0.24.0 milestone Dec 15, 2018
@pep8speaks
Copy link

pep8speaks commented Dec 15, 2018

Hello @jreback! Thanks for updating the PR.

Comment last updated on December 15, 2018 at 22:18 Hours UTC

@@ -289,7 +289,7 @@ class PeriodProperties(Properties):
"""


class CombinedDatetimelikeProperties(DatetimeProperties, TimedeltaProperties):
class CombinedDatetimelikeProperties(DatetimeProperties, TimedeltaProperties, PeriodProperties):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

period properties weren't availble on Series

@jreback
Copy link
Contributor Author

jreback commented Dec 15, 2018

@datapythonista @TomAugspurger if any comments.

@codecov
Copy link

codecov bot commented Dec 15, 2018

Codecov Report

Merging #24298 into master will decrease coverage by 49.26%.
The diff coverage is 20%.

Impacted file tree graph

@@             Coverage Diff             @@
##           master   #24298       +/-   ##
===========================================
- Coverage   92.28%   43.01%   -49.27%     
===========================================
  Files         162      162               
  Lines       51827    51827               
===========================================
- Hits        47827    22292    -25535     
- Misses       4000    29535    +25535
Flag Coverage Δ
#multiple ?
#single 43.01% <20%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/indexes/accessors.py 64.35% <20%> (-26.74%) ⬇️
pandas/io/formats/latex.py 0% <0%> (-100%) ⬇️
pandas/core/categorical.py 0% <0%> (-100%) ⬇️
pandas/io/sas/sas_constants.py 0% <0%> (-100%) ⬇️
pandas/tseries/plotting.py 0% <0%> (-100%) ⬇️
pandas/tseries/converter.py 0% <0%> (-100%) ⬇️
pandas/io/formats/html.py 0% <0%> (-98.65%) ⬇️
pandas/core/groupby/categorical.py 0% <0%> (-95.46%) ⬇️
pandas/io/sas/sas7bdat.py 0% <0%> (-91.17%) ⬇️
pandas/io/sas/sas_xport.py 0% <0%> (-90.15%) ⬇️
... and 121 more

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 ca85a41...f225dbb. Read the comment docs.

@codecov
Copy link

codecov bot commented Dec 15, 2018

Codecov Report

Merging #24298 into master will decrease coverage by <.01%.
The diff coverage is 80%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24298      +/-   ##
==========================================
- Coverage   92.28%   92.28%   -0.01%     
==========================================
  Files         162      162              
  Lines       51831    51831              
==========================================
- Hits        47832    47831       -1     
- Misses       3999     4000       +1
Flag Coverage Δ
#multiple 90.68% <80%> (ø) ⬆️
#single 43.01% <20%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/indexes/accessors.py 91.08% <80%> (ø) ⬆️
pandas/util/testing.py 87.48% <0%> (-0.1%) ⬇️

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 66fb798...cf1e3d3. Read the comment docs.

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great fixes, just couple of things that look like typos/mistakes


DatetimeIndex.argsort
DatetimeIndex.searchsorted
DatetimeIndex.sort_values
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you adding those?
(they are not datetime-specific)

Was it to remove certain warnings?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think they should be showing up in the DatetimeIndex class summary, since they aren't explicitly listed there under Methods.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have links in the whatsnew that need references, otherwise they don't go anywhere, e.g. :func:`DatetimeIndex.searchsorted`

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does adding them to the api.rst fix the references? Or do you need to also add them to the methods section in the DatetimeIndex docstring?

An alternative is something like "Fixed bug in :meth:`Index.searchsorted` for indexes with datetime values." would work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding to api.rst fixes this.

Does adding them to the api.rst fix the references? Or do you need to also add them to the methods section in the DatetimeIndex docstring?

What exactly do we guarantee with this? (answer is I am not sure)

"Fixed bug in :meth:Index.searchsorted

this would work as well. But, we currently don't have a method to check this (except visually).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the release I'll dust off #22743, which will fail the doc build if there are any warnings. So these kind of linking to a method that isn't in our API docs would have been caught when the PR was made.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok I reverted most of the additions and changed the refs. To be clear, I think this is actually a bug in that an invalid :meth: or :func: is not a warning if its misformatted, but I also think it is not warning when we just a sub-class of Index, but it doesn't render (the link). @datapythonista

@jreback jreback force-pushed the whatnew branch 2 times, most recently from a177c45 to 7ce9c83 Compare December 16, 2018 21:06
@jreback
Copy link
Contributor Author

jreback commented Dec 17, 2018

@jorisvandenbossche

@TomAugspurger
Copy link
Contributor

He may be unavailable this week.

Taking a look now.

Copy link
Contributor

@TomAugspurger TomAugspurger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few small typos.

@jreback
Copy link
Contributor Author

jreback commented Dec 17, 2018

pushed

@jreback
Copy link
Contributor Author

jreback commented Dec 17, 2018

@TomAugspurger

@TomAugspurger
Copy link
Contributor

LGTM. Thanks for tracking all these down.

@TomAugspurger TomAugspurger merged commit 87e9496 into pandas-dev:master Dec 17, 2018
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
…as-dev#24298)

* DOC: whatsnew 0.24.0 corrections & edits & remove some warnings

* review

* revert api refernces

* typos
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
…as-dev#24298)

* DOC: whatsnew 0.24.0 corrections & edits & remove some warnings

* review

* revert api refernces

* typos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants