Skip to content

Commit f061148

Browse files
committed
Update release notes
1 parent 04d8aa5 commit f061148

File tree

1 file changed

+9
-27
lines changed

1 file changed

+9
-27
lines changed

doc/source/whatsnew/v0.21.1.txt

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -23,33 +23,16 @@ the converter.
2323
>>> from pandas.plotting import register_matplotlib_converters
2424
>>> register_matplotlib_converters()
2525

26-
This caused problems for some users, so we're temporarily reverting that change;
27-
pandas will again register the converters on import. Using the converters
28-
without explicitly registering them will cause a ``FutureWarning``:
29-
30-
.. code-block:: python
31-
32-
>>> import pandas as pd
33-
>>> import matplotlib.pyplot as plt
34-
>>> fig, ax = plt.subplots()
35-
>>> ax.plot(pd.Series(range(12), index=pd.date_range('2017', periods=12)))
36-
FutureWarning: Using an implicitly registered datetime converter for a
37-
matplotlib plotting method. The converter was registered by pandas on import.
38-
Future versions of pandas will require you to explicitly register matplotlib
39-
converters.
40-
41-
To register the converters:
42-
>>> from pandas.plotting import register_matplotlib_converters
43-
>>> register_matplotlib_converters()
44-
45-
As the error message says, you'll need to register the converters if you intend
46-
to use them with matplotlib plotting functions. Pandas plotting functions, such
47-
as ``Series.plot``, will register them for you; calling ``register_converters``
48-
first is not necessary.
26+
This caused problems for some users who relied on those converters being present
27+
for regular ``matplotlib.pyplot`` plotting methods, so we're temporarily
28+
reverting that change; pandas will again register the converters on import.
29+
Pandas plotting functions, such as ``Series.plot``, will continue to register
30+
them for you.
4931

5032
We've added a new option to control the converters,
5133
``pd.options.plotting.matplotlib.register_converters``. By default, they are
52-
registered. Toggling this to ``False`` removes pandas' formatters (:issue:`18301`)
34+
registered. Toggling this to ``False`` removes pandas' formatters and restore
35+
any converters we overwrote when registering them (:issue:`18301`).
5336

5437
We're working with the matplotlib developers to make this easier. We're trying
5538
to balance user convenience (automatically registering the converters) with
@@ -80,9 +63,8 @@ Other Enhancements
8063
Deprecations
8164
~~~~~~~~~~~~
8265

83-
-
84-
-
85-
-
66+
- ``pandas.tseries.register`` has been renamed to
67+
:func:`pandas.plotting.register_matplotlib_converters`` (:issue:`18301`)
8668

8769
.. _whatsnew_0211.performance:
8870

0 commit comments

Comments
 (0)