-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Add Timestamp, Period, Timedelta, and Interval to api.rst #17424
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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #17424 +/- ##
==========================================
- Coverage 91.15% 91.14% -0.02%
==========================================
Files 163 163
Lines 49581 49591 +10
==========================================
Hits 45198 45198
- Misses 4383 4393 +10
Continue to review full report at Codecov.
|
doc/source/api.rst
Outdated
@@ -1438,6 +1438,15 @@ Categorical Components | |||
|
|||
.. _api.intervalindex: | |||
|
|||
Interval | |||
-------- | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add properties and methods for these Scalars? (you might be able to get away with a directive to list all of them, for Period/Interval might be ok, Timestamp will show everything from its inheritied classes). If you can build the docs and show would be great (if there are too many things shown, we might just list some attributes / methods and point to the datetime.datetime
docs otherwise.)
Can you also add for Timedelta
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doc/source/api.rst
Outdated
@@ -1567,6 +1576,22 @@ Conversion | |||
DatetimeIndex.to_pydatetime | |||
DatetimeIndex.to_series | |||
|
|||
Period | |||
------ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also these need to go in a new section: Scalars I think (alternatively they could go with there associated Indexes), but I think a Scalars section is fine.
thanks! note pls have a look at the built docs (may take a bit for it to generate) http://pandas-docs.github.io/pandas-docs-travis/ want to make sure that searching works ok. Then of course we want to enhance doc-strings where appropriate (which is already an outstanding issue IIRC), if you are interested. |
http://pandas-docs.github.io/pandas-docs-travis/api.html#scalars couple of corrections needed
|
git diff upstream/master -u -- "*.py" | flake8 --diff