Rename it all

Author: TomAugspurger

doc/source/options.rst

@@ -20,8 +20,8 @@ the converter.
 
 .. code-block:: python
 
-   >>> from pandas.plotting import register_converters
-   >>> register_converters()
+   >>> from pandas.plotting import register_matplotlib_converters
+   >>> register_matplotlib_converters()
 
 This caused problems for some users, so we're temporarily reverting that change;
 pandas will again register the converters on import. Using the converters
@@ -39,16 +39,16 @@ without explicitly registering them will cause a ``FutureWarning``:
    converters.
 
    To register the converters:
-           >>> from pandas.plotting import register_converters
-           >>> register_converters()
+           >>> from pandas.plotting import register_matplotlib_converters
+           >>> register_matplotlib_converters()
 
 As the error message says, you'll need to register the converters if you intend
 to use them with matplotlib plotting functions. Pandas plotting functions, such
 as ``Series.plot``, will register them for you; calling ``register_converters``
 first is not necessary.
 
 We've added a new option to control the converters,
-``pd.options.plotting.mpl.converters``. By default, they are
+``pd.options.plotting.matplotlib.register_converters``. By default, they are
 registered. Toggling this to ``False`` removes pandas' formatters (:issue:`18301`)
 
 We're working with the matplotlib developers to make this easier. We're trying

doc/source/whatsnew/v0.21.1.txt

@@ -494,14 +494,15 @@ def use_inf_as_na_cb(key):
 
 
 def register_converter_cb(key):
-    from pandas.plotting import register_converters, deregister_converters
+    from pandas.plotting import register_matplotlib_converters
+    from pandas.plotting import deregister_matplotlib_converters
 
     if cf.get_option(key):
-        register_converters()
+        register_matplotlib_converters()
     else:
-        deregister_converters()
+        deregister_matplotlib_converters()
 
 
-with cf.config_prefix("plotting.mpl"):
-    cf.register_option("converters", True, register_converter_doc,
+with cf.config_prefix("plotting.matplotlib"):
+    cf.register_option("register_converters", True, register_converter_doc,
                        validator=bool, cb=register_converter_cb)

pandas/core/config_init.py

@@ -12,7 +12,9 @@
 from pandas.plotting._style import plot_params
 from pandas.plotting._tools import table
 try:
-    from pandas.plotting._converter import register as register_converters
-    from pandas.plotting._converter import deregister as deregister_converters
+    from pandas.plotting._converter import \
+        register as register_matplotlib_converters
+    from pandas.plotting._converter import \
+        deregister as deregister_matplotlib_converters
 except ImportError:
     pass

pandas/plotting/__init__.py

@@ -76,8 +76,9 @@ def register(warn=False):
 
     See Also
     --------
-    deregister
+    deregister_matplotlib_converter
     """
+    # Renamed in pandas.plotting.__init__
     global _WARN
 
     if not warn:
@@ -103,8 +104,9 @@ def deregister():
 
     See Also
     --------
-    register
+    deregister_matplotlib_converters
     """
+    # Renamed in pandas.plotting.__init__
     for type_, cls in get_pairs():
         # We use type to catch our classes directly, no inheritance
         if type(units.registry.get(type_)) is cls:
@@ -127,8 +129,9 @@ def _check_implicitly_registered():
                "by pandas on import. Future versions of pandas will require "
                "you to explicitly register matplotlib converters.\n\n"
                "To register the converters:\n\t"
-               ">>> from pandas.plotting import register_converters\n\t"
-               ">>> register_converters()")
+               ">>> from pandas.plotting import register_matplotlib_converters"
+               "\n\t"
+               ">>> register_matplotlib_converters()")
         warnings.warn(msg, FutureWarning)
         _WARN = False
 

pandas/plotting/_converter.py

@@ -46,7 +46,7 @@
 except ImportError:
     pass
 else:
-    if get_option('plotting.mpl.converters'):
+    if get_option('plotting.matplotlib.register_converters'):
         _converter.register(warn=True)
 
 

pandas/plotting/_core.py

@@ -10,6 +10,8 @@
 from pandas.compat.numpy import np_datetime64_compat
 
 converter = pytest.importorskip('pandas.plotting._converter')
+from pandas.plotting import (register_matplotlib_converters,
+                             deregister_matplotlib_converters)
 
 
 def test_timtetonum_accepts_unicode():
@@ -40,7 +42,7 @@ def test_registering_no_warning(self):
 
         # Set to the "warn" state, in case this isn't the first test run
         converter._WARN = True
-        converter.register()
+        register_matplotlib_converters()
         with tm.assert_produces_warning(None) as w:
             ax.plot(s.index, s.values)
 
@@ -60,15 +62,17 @@ def test_matplotlib_formatters(self):
         units = pytest.importorskip("matplotlib.units")
         assert Timestamp in units.registry
 
-        ctx = cf.option_context("plotting.mpl.converters", False)
+        ctx = cf.option_context("plotting.matplotlib.register_converters",
+                                False)
         with ctx:
             assert Timestamp not in units.registry
 
         assert Timestamp in units.registry
 
     def test_option_no_warning(self):
         pytest.importorskip("matplotlib.pyplot")
-        ctx = cf.option_context("plotting.mpl.converters", False)
+        ctx = cf.option_context("plotting.matplotlib.register_converters",
+                                False)
         plt = pytest.importorskip("matplotlib.pyplot")
         s = Series(range(12), index=date_range('2017', periods=12))
         _, ax = plt.subplots()
@@ -83,7 +87,7 @@ def test_option_no_warning(self):
 
         # Now test with registering
         converter._WARN = True
-        converter.register()
+        register_matplotlib_converters()
         with ctx:
             with tm.assert_produces_warning(None) as w:
                 ax.plot(s.index, s.values)
@@ -104,9 +108,9 @@ def test_registry_resets(self):
             units.registry[datetime] = date_converter
             units.registry[date] = date_converter
 
-            converter.register()
+            register_matplotlib_converters()
             assert not units.registry[date] is date_converter
-            converter.deregister()
+            deregister_matplotlib_converters()
             assert units.registry[date] is date_converter
 
         finally: