-
-
Notifications
You must be signed in to change notification settings - Fork 17.8k
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
DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta #20142
Merged
jorisvandenbossche
merged 5 commits into
pandas-dev:master
from
ijmbarr:docstring_to_pytimedelta
Mar 17, 2018
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
660fbb1
DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta
ijmbarr 2aa395b
DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta
ijmbarr 18d67b6
DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta
ijmbarr c490ef4
DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta
ijmbarr 48ca62c
Update accessors.py
jorisvandenbossche 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 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 |
---|---|---|
|
@@ -157,6 +157,39 @@ class TimedeltaProperties(Properties): | |
""" | ||
|
||
def to_pytimedelta(self): | ||
""" | ||
Return array of Timedeltas as `datetime.timedelta`. | ||
|
||
Python's standard `datetime` library uses a different representation to | ||
what pandas for differences between times. This method converts a | ||
Series of pandas Timedeltas to `datetime.timedelta` format with | ||
the same length as the original Series. | ||
|
||
Returns | ||
------- | ||
a : numpy.ndarray | ||
1D array containing data with `datetime.timedelta` type. | ||
|
||
Examples | ||
-------- | ||
>>> s = pd.Series(pd.to_timedelta(np.arange(5), unit='d')) | ||
>>> s | ||
0 0 days | ||
1 1 days | ||
2 2 days | ||
3 3 days | ||
4 4 days | ||
dtype: timedelta64[ns] | ||
|
||
>>> s.dt.to_pytimedelta() | ||
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. can you add a blank line before this case 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. Added. |
||
array([datetime.timedelta(0), datetime.timedelta(1), | ||
datetime.timedelta(2), datetime.timedelta(3), | ||
datetime.timedelta(4)], dtype=object) | ||
|
||
See Also | ||
-------- | ||
datetime.timedelta | ||
""" | ||
return self._get_values().to_pytimedelta() | ||
|
||
@property | ||
|
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.
I think we need
import datetime
hereThere 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.
I don't seem to need the import, but to clarify things, I've added more to the description.