Skip to content

DOC: Improved the docstring of pandas.Series.dt.components #20177

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
Jul 8, 2018
Merged

DOC: Improved the docstring of pandas.Series.dt.components #20177

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3202b20
DOC: Improved the docstring of pandas.Series.dt.components
ijmbarr Mar 10, 2018
49500b0
Merge remote-tracking branch 'upstream/master' into docstring_dt_comp…
WillAyd Jul 8, 2018
ec3860f
Simplified docstring
WillAyd Jul 8, 2018
d1ddfb2
LINT exception
WillAyd Jul 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions pandas/core/indexes/accessors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,14 +237,30 @@ def to_pytimedelta(self):
@property
def components(self):
"""
Return a dataframe of the components (days, hours, minutes,
seconds, milliseconds, microseconds, nanoseconds) of the Timedeltas.
Return a Dataframe of the components of the Timedeltas.
Returns
-------
a DataFrame
DataFrame
"""
Examples
--------
>>> s = pd.Series(pd.to_timedelta(np.arange(5), unit='s'))
>>> s
0 00:00:00
1 00:00:01
2 00:00:02
3 00:00:03
4 00:00:04
dtype: timedelta64[ns]
>>> s.dt.components
days hours minutes seconds milliseconds microseconds nanoseconds
0 0 0 0 0 0 0 0
1 0 0 0 1 0 0 0
2 0 0 0 2 0 0 0
3 0 0 0 3 0 0 0
4 0 0 0 4 0 0 0
""" # noqa: E501
return self._get_values().components.set_index(self.index)

@property
Expand Down