REORG: _types -> _enums

brunobeltran · brunobeltran · commit 4894099e025f · 2021-02-01T10:23:33.000-08:00
diff --git a/doc/api/_enums.rst b/doc/api/_enums.rst
@@ -1,8 +1,8 @@
 **********************
-``matplotlib._types``
+``matplotlib._enums``
 **********************
 
-.. automodule:: matplotlib._types
+.. automodule:: matplotlib._enums
    :no-members:
 
    .. autoclass:: JoinStyle
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -89,6 +89,7 @@ Matplotlib consists of the following submodules:
    dates_api.rst
    docstring_api.rst
    dviread.rst
+   _enums.rst
    figure_api.rst
    font_manager_api.rst
    fontconfig_pattern_api.rst
@@ -124,7 +125,6 @@ Matplotlib consists of the following submodules:
    transformations.rst
    tri_api.rst
    type1font.rst
-   _types.rst
    units_api.rst
    widgets_api.rst
    _api_api.rst
diff --git a/examples/lines_bars_and_markers/capstyle.py b/examples/lines_bars_and_markers/capstyle.py
@@ -3,13 +3,13 @@
 CapStyle
 =========
 
-The `matplotlib._types.CapStyle` controls how Matplotlib draws the corners
+The `matplotlib._enums.CapStyle` controls how Matplotlib draws the corners
 where two different line segments meet. For more details, see the
-`~matplotlib._types.CapStyle` docs.
+`~matplotlib._enums.CapStyle` docs.
 """
 
 import matplotlib.pyplot as plt
-from matplotlib._types import CapStyle
+from matplotlib._enums import CapStyle
 
 CapStyle.demo()
 plt.show()
diff --git a/examples/lines_bars_and_markers/joinstyle.py b/examples/lines_bars_and_markers/joinstyle.py
@@ -3,13 +3,13 @@
 JoinStyle
 =========
 
-The `matplotlib._types.JoinStyle` controls how Matplotlib draws the corners
+The `matplotlib._enums.JoinStyle` controls how Matplotlib draws the corners
 where two different line segments meet. For more details, see the
-`~matplotlib._types.JoinStyle` docs.
+`~matplotlib._enums.JoinStyle` docs.
 """
 
 import matplotlib.pyplot as plt
-from matplotlib._types import JoinStyle
+from matplotlib._enums import JoinStyle
 
 JoinStyle.demo()
 plt.show()
diff --git a/lib/matplotlib/_enums.py b/lib/matplotlib/_enums.py
@@ -1,5 +1,5 @@
 """
-Matplotlib API concepts that would not otherwise merit a dedicated class.
+Enums representing sets of strings that Matplotlib uses as input parameters.
 
 Matplotlib often uses simple data types like strings or tuples to define a
 concept; e.g. the line capstyle can be specified as one of 'butt', 'round',
@@ -91,7 +91,7 @@ class JoinStyle(str, _AutoStringNameEnum):
     .. plot::
         :alt: Demo of possible JoinStyle's
 
-        from matplotlib._types import JoinStyle
+        from matplotlib._enums import JoinStyle
         JoinStyle.demo()
 
     """
@@ -165,7 +165,7 @@ class CapStyle(str, _AutoStringNameEnum):
     .. plot::
         :alt: Demo of possible CapStyle's
 
-        from matplotlib._types import CapStyle
+        from matplotlib._enums import CapStyle
         CapStyle.demo()
 
     """
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -51,7 +51,7 @@
 from matplotlib.cbook import _setattr_cm
 from matplotlib.path import Path
 from matplotlib.transforms import Affine2D
-from matplotlib._types import JoinStyle, CapStyle
+from matplotlib._enums import JoinStyle, CapStyle
 
 
 _log = logging.getLogger(__name__)
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -16,7 +16,7 @@
 import matplotlib as mpl
 from . import (_api, _path, artist, cbook, cm, colors as mcolors, docstring,
                hatch as mhatch, lines as mlines, path as mpath, transforms)
-from ._types import JoinStyle, CapStyle
+from ._enums import JoinStyle, CapStyle
 import warnings
 
 
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -17,7 +17,7 @@
 from .markers import MarkerStyle
 from .path import Path
 from .transforms import Bbox, BboxTransformTo, TransformedPath
-from ._types import JoinStyle, CapStyle
+from ._enums import JoinStyle, CapStyle
 
 # Imported here for backward compatibility, even though they don't
 # really belong.
diff --git a/lib/matplotlib/markers.py b/lib/matplotlib/markers.py
@@ -134,7 +134,7 @@
 from . import _api, cbook, rcParams
 from .path import Path
 from .transforms import IdentityTransform, Affine2D
-from ._types import JoinStyle, CapStyle
+from ._enums import JoinStyle, CapStyle
 
 # special-purpose marker identifiers:
 (TICKLEFT, TICKRIGHT, TICKUP, TICKDOWN,
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -16,7 +16,7 @@
     get_parallels, inside_circle, make_wedged_bezier2,
     split_bezier_intersecting_with_closedpath, split_path_inout)
 from .path import Path
-from ._types import JoinStyle, CapStyle
+from ._enums import JoinStyle, CapStyle
 
 
 @cbook._define_aliases({
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -26,7 +26,7 @@
 from matplotlib.cbook import ls_mapper
 from matplotlib.colors import Colormap, is_color_like
 from matplotlib.fontconfig_pattern import parse_fontconfig_pattern
-from matplotlib._types import JoinStyle, CapStyle
+from matplotlib._enums import JoinStyle, CapStyle
 
 # Don't let the original cycler collide with our validating cycler
 from cycler import Cycler, cycler as ccycler
diff --git a/lib/matplotlib/tests/test_collections.py b/lib/matplotlib/tests/test_collections.py
@@ -8,12 +8,10 @@
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 import matplotlib.collections as mcollections
-import matplotlib.transforms as mtransforms
 from matplotlib.collections import (Collection, LineCollection,
                                     EventCollection, PolyCollection)
-import matplotlib.pyplot as plt
-from matplotlib.testing.decorators import check_figures_equal, image_comparison
 import matplotlib.transforms as mtransforms
+from matplotlib.testing.decorators import check_figures_equal, image_comparison
 
 
 def generate_EventCollection_plot():
