-
-
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1438,6 +1438,15 @@ Categorical Components | |
|
||
.. _api.intervalindex: | ||
|
||
Interval | ||
-------- | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
:template: autosummary/class_without_autosummary.rst | ||
|
||
Interval | ||
|
||
IntervalIndex | ||
------------- | ||
|
||
|
@@ -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 commentThe 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. |
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
Period | ||
|
||
Timestamp | ||
--------- | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
Timestamp | ||
|
||
TimedeltaIndex | ||
-------------- | ||
|
||
|
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
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.
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.
Ends up looking like above for
Timestamp
andPeriod
. There's also room to clarifydays_in_month
vsdaysinmonth
as a compatibility alias. It looks like a lot of the existing properties don't need to be there - any guidance on this?