Skip to content

DOC: Update the pandas.Series.dt.round/floor/ceil docstrings #20187

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 3 commits into from
Mar 11, 2018
Merged

DOC: Update the pandas.Series.dt.round/floor/ceil docstrings #20187

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26d1f5d
chncyhn Mar 10, 2018
e58f406
chncyhn Mar 10, 2018
fcd3bdf
Add series
TomAugspurger Mar 11, 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
49 changes: 43 additions & 6 deletions pandas/core/indexes/datetimelike.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,21 +82,58 @@ class TimelikeOps(object):

_round_doc = (
"""
%s the index to the specified freq
{op} the index to the specified `freq`.

Parameters
----------
freq : freq string/object
The frequency level to {op} the index to.

Returns
-------
index of same type
index of same type.

Raises
------
ValueError if the freq cannot be converted
ValueError if the `freq` cannot be converted.

Notes
-----
See :ref:`frequency aliases <timeseries.offset_aliases>` for
a list of possible `freq` values.

Examples
--------
>>> rng = pd.date_range('1/1/2018 11:59:00', periods=3, freq='min')
>>> rng
DatetimeIndex(['2018-01-01 11:59:00', '2018-01-01 12:00:00',
'2018-01-01 12:01:00'],
dtype='datetime64[ns]', freq='T')
""")

_round_example = (
""">>> rng.round('H')
DatetimeIndex(['2018-01-01 12:00:00', '2018-01-01 12:00:00',
'2018-01-01 12:00:00'],
dtype='datetime64[ns]', freq=None)
""")

_floor_example = (
""">>> rng.floor('H')
DatetimeIndex(['2018-01-01 11:00:00', '2018-01-01 12:00:00',
'2018-01-01 12:00:00'],
dtype='datetime64[ns]', freq=None)
"""
)

_ceil_example = (
""">>> rng.ceil('H')
DatetimeIndex(['2018-01-01 12:00:00', '2018-01-01 12:00:00',
'2018-01-01 13:00:00'],
dtype='datetime64[ns]', freq=None)
"""
)

def _round(self, freq, rounder):
# round the local times
values = _ensure_datetimelike_to_i8(self)
Expand All @@ -111,15 +148,15 @@ def _round(self, freq, rounder):
return self._ensure_localized(
self._shallow_copy(result, **attribs))

@Appender(_round_doc % "round")
@Appender((_round_doc + _round_example).format(op="round"))
def round(self, freq, *args, **kwargs):
return self._round(freq, np.round)

@Appender(_round_doc % "floor")
@Appender((_round_doc + _floor_example).format(op="floor"))
def floor(self, freq):
return self._round(freq, np.floor)

@Appender(_round_doc % "ceil")
@Appender((_round_doc + _ceil_example).format(op="ceil"))
def ceil(self, freq):
return self._round(freq, np.ceil)

Expand Down