@@ -2204,29 +2204,30 @@ def _generate_regular_range(start, end, periods, offset):
2204
2204
def date_range (start = None , end = None , periods = None , freq = 'D' , tz = None ,
2205
2205
normalize = False , name = None , closed = None , ** kwargs ):
2206
2206
"""
2207
- Return a fixed frequency DatetimeIndex, with day (calendar) as the default
2208
- frequency
2207
+ Return a fixed frequency DatetimeIndex.
2208
+
2209
+ The default frequency is day (calendar).
2209
2210
2210
2211
Parameters
2211
2212
----------
2212
2213
start : string or datetime-like, default None
2213
- Left bound for generating dates
2214
+ Left bound for generating dates.
2214
2215
end : string or datetime-like, default None
2215
- Right bound for generating dates
2216
+ Right bound for generating dates.
2216
2217
periods : integer, default None
2217
- Number of periods to generate
2218
+ Number of periods to generate.
2218
2219
freq : string or DateOffset, default 'D' (calendar daily)
2219
- Frequency strings can have multiples, e.g. '5H'
2220
+ Frequency strings can have multiples, e.g. '5H'.
2220
2221
tz : string, default None
2221
2222
Time zone name for returning localized DatetimeIndex, for example
2222
- Asia/Hong_Kong
2223
+ Asia/Hong_Kong.
2223
2224
normalize : bool, default False
2224
- Normalize start/end dates to midnight before generating date range
2225
+ Normalize start/end dates to midnight before generating date range.
2225
2226
name : string, default None
2226
- Name of the resulting DatetimeIndex
2227
+ Name of the resulting DatetimeIndex.
2227
2228
closed : string, default None
2228
2229
Make the interval closed with respect to the given frequency to
2229
- the 'left', 'right', or both sides (None)
2230
+ the 'left', 'right', or both sides (None).
2230
2231
2231
2232
Notes
2232
2233
-----
@@ -2239,6 +2240,22 @@ def date_range(start=None, end=None, periods=None, freq='D', tz=None,
2239
2240
Returns
2240
2241
-------
2241
2242
rng : DatetimeIndex
2243
+
2244
+ See Also
2245
+ --------
2246
+ pandas.period_range : Return a fixed frequency PeriodIndex.
2247
+ pandas.interval_range : Return a fixed frequency IntervalIndex.
2248
+
2249
+ Examples
2250
+ --------
2251
+ >>> pd.date_range('2018-10-03', periods=2) # doctest: +NORMALIZE_WHITESPACE
2252
+ DatetimeIndex(['2018-10-03', '2018-10-04'], dtype='datetime64[ns]',
2253
+ freq='D')
2254
+
2255
+ >>> pd.date_range(start='2018-01-01', end='20180103')
2256
+ ... # doctest: +NORMALIZE_WHITESPACE
2257
+ DatetimeIndex(['2018-01-01', '2018-01-02', '2018-01-03'],
2258
+ dtype='datetime64[ns]', freq='D')
2242
2259
"""
2243
2260
return DatetimeIndex (start = start , end = end , periods = periods ,
2244
2261
freq = freq , tz = tz , normalize = normalize , name = name ,
0 commit comments