Merge pull request #2011 from pelson/api_changes_sketch

mdboom · mdboom · commit 24a635f78604 · 2013-05-21T07:11:19.000-07:00
Added the "cleared" method to Path, and updated the path module's documentation.
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -104,6 +104,15 @@ Changes in 1.3.x
   existing text objects.  This brings their behavior in line with most
   other rcParams.
 
+* To support XKCD style plots, the :func:`matplotlib.path.cleanup_path`
+  method's signature was updated to require a sketch argument. Users of
+  :func:`matplotlib.path.cleanup_path` are encouraged to use the new
+  :meth:`~matplotlib.path.Path.cleaned` Path method.
+
+* The list at ``Path.NUM_VERTICES`` was replaced by a dictionary mapping
+  Path codes to the number of expected vertices at
+  :attr:`~matplotlib.path.Path.NUM_VERTICES_FOR_CODE`.
+
 * Fixed a bug in setting the position for the right/top spine with data
   position type. Previously, it would draw the right or top spine at
   +1 data offset.
diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py
@@ -189,9 +189,9 @@ def __init__(self, norm=None, cmap=None):
             norm = colors.Normalize()
 
         self._A = None;
-        #; The Normalization instance of this ScalarMappable.
+        #: The Normalization instance of this ScalarMappable.
         self.norm = norm
-        #; The Colormap instance of this ScalarMappable.
+        #: The Colormap instance of this ScalarMappable.
         self.cmap = get_cmap(cmap)
         self.colorbar = None
         self.update_dict = {'array': False}
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
