Skip to content

DOC: timedelta return type #44592

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.

Sign up for GitHub

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
Nov 24, 2021
Merged

DOC: timedelta return type #44592

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f4d0e6
DOC: change return type #42316
loicdiridollou Nov 23, 2021
d10a35a
DOC: updating docstring
loicdiridollou Nov 23, 2021
8cc8138
Doc changing the Returns docstring to adhere to to_datetime structure
loicdiridollou Nov 23, 2021
3077510
DOC: combining types
loicdiridollou Nov 23, 2021
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
2 changes: 1 addition & 1 deletion pandas/core/tools/timedeltas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def to_timedelta(arg, unit=None, errors="raise"):

Returns
-------
timedelta64 or numpy.array of timedelta64
Timedelta or TimedeltaIndex of timedelta64
Copy link
Member

@mroeschke mroeschke Nov 23, 2021

Choose a reason for hiding this comment

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

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
Output type returned if parsing succeeded.

See Also
Expand Down