Skip to content

Commit 55dfae7

Browse files
Revert "DOC: Fixes after #17482 (#17554)"
This reverts commit 643fc1e.
1 parent 3b0d1f6 commit 55dfae7

File tree

5 files changed

+12
-10
lines changed

5 files changed

+12
-10
lines changed

doc/source/whatsnew/v0.21.0.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ Additionally, DataFrames with datetime columns that were parsed by :func:`read_s
363363
Consistency of Range Functions
364364
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
365365

366-
In previous versions, there were some inconsistencies between the various range functions: :func:`date_range`, :func:`bdate_range`, :func:`cdate_range`, :func:`period_range`, :func:`timedelta_range`, and :func:`interval_range`. (:issue:`17471`).
366+
In previous versions, there were some inconsistencies between the various range functions: func:`date_range`, func:`bdate_range`, func:`cdate_range`, func:`period_range`, func:`timedelta_range`, and func:`interval_range`. (:issue:`17471`).
367367

368368
One of the inconsistent behaviors occurred when the ``start``, ``end`` and ``period`` parameters were all specified, potentially leading to ambiguous ranges. When all three parameters were passed, ``interval_range`` ignored the ``period`` parameter, ``period_range`` ignored the ``end`` parameter, and the other range functions raised. To promote consistency among the range functions, and avoid potentially ambiguous ranges, ``interval_range`` and ``period_range`` will now raise when all three parameters are passed.
369369

pandas/core/api.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@
1616
PeriodIndex, NaT)
1717
from pandas.core.indexes.period import Period, period_range, pnow
1818
from pandas.core.indexes.timedeltas import Timedelta, timedelta_range
19-
from pandas.core.indexes.datetimes import (Timestamp, date_range, bdate_range,
20-
cdate_range)
19+
from pandas.core.indexes.datetimes import Timestamp, date_range, bdate_range
2120
from pandas.core.indexes.interval import Interval, interval_range
2221

2322
from pandas.core.series import Series

pandas/core/indexes/datetimes.py

+7-2
Original file line numberDiff line numberDiff line change
@@ -2094,8 +2094,13 @@ def bdate_range(start=None, end=None, periods=None, freq='B', tz=None,
20942094
def cdate_range(start=None, end=None, periods=None, freq='C', tz=None,
20952095
normalize=True, name=None, closed=None, **kwargs):
20962096
"""
2097-
Return a fixed frequency DatetimeIndex, with CustomBusinessDay as the
2098-
default frequency
2097+
**EXPERIMENTAL** Return a fixed frequency DatetimeIndex, with
2098+
CustomBusinessDay as the default frequency
2099+
2100+
.. warning:: EXPERIMENTAL
2101+
2102+
The CustomBusinessDay class is not officially supported and the API is
2103+
likely to change in future versions. Use this at your own risk.
20992104
21002105
Parameters
21012106
----------

pandas/core/indexes/interval.py

+2-4
Original file line numberDiff line numberDiff line change
@@ -1094,8 +1094,7 @@ def interval_range(start=None, end=None, periods=None, freq=None,
10941094
10951095
Additionally, datetime-like input is also supported.
10961096
1097-
>>> pd.interval_range(start=pd.Timestamp('2017-01-01'),
1098-
end=pd.Timestamp('2017-01-04'))
1097+
>>> pd.interval_range(start='2017-01-01', end='2017-01-04')
10991098
IntervalIndex([(2017-01-01, 2017-01-02], (2017-01-02, 2017-01-03],
11001099
(2017-01-03, 2017-01-04]]
11011100
closed='right', dtype='interval[datetime64[ns]]')
@@ -1111,8 +1110,7 @@ def interval_range(start=None, end=None, periods=None, freq=None,
11111110
Similarly, for datetime-like ``start`` and ``end``, the frequency must be
11121111
convertible to a DateOffset.
11131112
1114-
>>> pd.interval_range(start=pd.Timestamp('2017-01-01'),
1115-
periods=3, freq='MS')
1113+
>>> pd.interval_range(start='2017-01-01', periods=3, freq='MS')
11161114
IntervalIndex([(2017-01-01, 2017-02-01], (2017-02-01, 2017-03-01],
11171115
(2017-03-01, 2017-04-01]]
11181116
closed='right', dtype='interval[datetime64[ns]]')

pandas/tests/api/test_api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ class TestPDApi(Base):
6363
# top-level functions
6464
funcs = ['bdate_range', 'concat', 'crosstab', 'cut',
6565
'date_range', 'interval_range', 'eval',
66-
'factorize', 'get_dummies', 'cdate_range',
66+
'factorize', 'get_dummies',
6767
'infer_freq', 'isna', 'isnull', 'lreshape',
6868
'melt', 'notna', 'notnull', 'offsets',
6969
'merge', 'merge_ordered', 'merge_asof',

0 commit comments

Comments
 (0)