From b3d6ce66946b9202cccaab6142a4f4b7389e9f33 Mon Sep 17 00:00:00 2001 From: Nipun Sadvilkar Date: Sun, 11 Mar 2018 17:29:33 +0530 Subject: [PATCH] DOC: update the pandas.date_range() docstring (#20143) * DOC: Improved the docstring of pandas.date_range() * Change date strings to iso format * Removed import pands in Examples docstring * Add See Also Docstring * Update datetimes.py * Doctests --- pandas/core/indexes/datetimes.py | 37 +++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index 491fefe8efee0..b9c4b59536d0c 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -2204,29 +2204,30 @@ def _generate_regular_range(start, end, periods, offset): def date_range(start=None, end=None, periods=None, freq='D', tz=None, normalize=False, name=None, closed=None, **kwargs): """ - Return a fixed frequency DatetimeIndex, with day (calendar) as the default - frequency + Return a fixed frequency DatetimeIndex. + + The default frequency is day (calendar). Parameters ---------- start : string or datetime-like, default None - Left bound for generating dates + Left bound for generating dates. end : string or datetime-like, default None - Right bound for generating dates + Right bound for generating dates. periods : integer, default None - Number of periods to generate + Number of periods to generate. freq : string or DateOffset, default 'D' (calendar daily) - Frequency strings can have multiples, e.g. '5H' + Frequency strings can have multiples, e.g. '5H'. tz : string, default None Time zone name for returning localized DatetimeIndex, for example - Asia/Hong_Kong + Asia/Hong_Kong. normalize : bool, default False - Normalize start/end dates to midnight before generating date range + Normalize start/end dates to midnight before generating date range. name : string, default None - Name of the resulting DatetimeIndex + Name of the resulting DatetimeIndex. closed : string, default None Make the interval closed with respect to the given frequency to - the 'left', 'right', or both sides (None) + the 'left', 'right', or both sides (None). Notes ----- @@ -2239,6 +2240,22 @@ def date_range(start=None, end=None, periods=None, freq='D', tz=None, Returns ------- rng : DatetimeIndex + + See Also + -------- + pandas.period_range : Return a fixed frequency PeriodIndex. + pandas.interval_range : Return a fixed frequency IntervalIndex. + + Examples + -------- + >>> pd.date_range('2018-10-03', periods=2) # doctest: +NORMALIZE_WHITESPACE + DatetimeIndex(['2018-10-03', '2018-10-04'], dtype='datetime64[ns]', + freq='D') + + >>> pd.date_range(start='2018-01-01', end='20180103') + ... # doctest: +NORMALIZE_WHITESPACE + DatetimeIndex(['2018-01-01', '2018-01-02', '2018-01-03'], + dtype='datetime64[ns]', freq='D') """ return DatetimeIndex(start=start, end=end, periods=periods, freq=freq, tz=tz, normalize=normalize, name=name,