Skip to content

Commit 7175dc5

Browse files
committed
DOC: enhance documentation for date_range
Added extended summary.
1 parent 7e88123 commit 7175dc5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

pandas/core/indexes/datetimes.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -864,6 +864,15 @@ def date_range(
864864
"""
865865
Return a fixed frequency DatetimeIndex.
866866
867+
Returns the range of equally spaced timesteps (where the time offset between any
868+
two adjacent timesteps is specified by the given frequency) such that they all
869+
satisfy `start <[=] timestep <[=] end`, where the first and last timesteps are
870+
the first and last timesteps in that range that fall on the boundary of ``freq``
871+
(if given as a frequency string) or that are valid for ``freq`` (if given as a
872+
:class:`pandas.tseries.offsets.DateOffset`). (If exactly one of ``start``,
873+
``end``, or ``freq`` is not specified, it can be computed given ``periods``,
874+
the number of timesteps in the range. See the note below.)
875+
867876
Parameters
868877
----------
869878
start : str or datetime-like, optional

0 commit comments

Comments
 (0)