DOC: timedelta return type #44592
Merged
DOC: timedelta return type #44592
+7
−2
Conversation
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
Contributor
loicdiridollou
commented
Nov 23, 2021
loicdiridollou
commented
- closes DOC: timedelta return type #42316
- [NA] tests added / passed
- Ensure all linting tests pass, see here for how to run them
- [NA] whatsnew entry
mroeschke
reviewed
Nov 23, 2021
pandas/core/tools/timedeltas.py
Outdated
| @@ -68,7 +68,7 @@ def to_timedelta(arg, unit=None, errors="raise"): | |||
|
|
|||
| Returns | |||
| ------- | |||
| timedelta64 or numpy.array of timedelta64 | |||
| Timedelta or TimedeltaIndex of timedelta64 | |||
There was a problem hiding this comment.
This can also return a Series of timedelta64[ns] if a Series is the input.
Would be great if you could organize this Returns sections like the Returns section of to_datetime
mroeschke
reviewed
Nov 23, 2021
pandas/core/tools/timedeltas.py
Outdated
|
|
||
| - list-like: TimedeltaIndex of timedelta64 dtype | ||
| - Series: Series of timedelta64 dtype | ||
| - Timedelta: Timedelta |
There was a problem hiding this comment.
Nit: Could you summarize this and line below as - scalar: Timedelta. scalar includes str, datetime.timedelta, np.timedelta64, etc.
There was a problem hiding this comment.
Good catch! I wasn't sure at first that Timedelta was considered a scalar but should have checked with pandas.api.types.is_scalar, my mistake, it is fixed
mroeschke
approved these changes
Nov 24, 2021
|
Thanks @loicdiridollou! Awesome job. Happy to have more of these doc issues addressed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.