Add a name parameter to truncate

lkilcher · lkilcher · commit 79bfcfbc62ad · 2017-01-01T09:31:33.000-07:00
reorder `join` inputs (for consistency)
+doc fixes/changes
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -589,21 +589,21 @@ def reversed(self, name=None):
         """
         raise NotImplementedError()
 
-    def join(self, other, name=None, frac_self=None, N=None):
+    def join(self, other, frac_self=None, name=None, N=None):
         """
         Join colormap `self` to `other` and return the new colormap.
 
         Parameters
         ----------
         other : cmap
             The other colormap to be joined to this one.
-        name : str, optional
-            The name for the reversed colormap. If it's None the
-            name will be ``self.name + '-' + other.name``.
         frac_self : float in the interval ``(0.0, 1.0)``, optional
             The fraction of the new colormap that should be occupied
             by self. By default, this is ``self.N / (self.N +
             other.N)``.
+        name : str, optional
+            The name for the joined colormap. This defaults to
+            ``self.name + '+' + other.name``
         N : int
             The number of entries in the color map.  The default is ``None``,
             in which case the number of entries is the sum of the
@@ -646,7 +646,7 @@ def join(self, other, name=None, frac_self=None, N=None):
 
     __add__ = join
 
-    def truncate(self, minval=0.0, maxval=1.0, N=None):
+    def truncate(self, minval=0.0, maxval=1.0, name=None, N=None):
         """
         Truncate a colormap.
 
@@ -655,11 +655,12 @@ def truncate(self, minval=0.0, maxval=1.0, N=None):
         minval : float in the interval ``(0.0, 1.0)``, optional
             The lower fraction of the colormap you want to truncate
             (default 0.0).
-
         maxval : float in the interval ``(0.0, 1.0)``, optional
             The upper limit of the colormap you want to keep. i.e. truncate
             the section above this value (default 1.0).
-
+        name : str, optional
+            The name for the new truncated colormap. This defaults to
+            ``"trunc({},{:.2f},{:.2f})".format(self.name, minval, maxval)``
         N : int
             The number of entries in the map. The default is *None*,
             in which case the same color-step density is preserved,
@@ -694,7 +695,8 @@ def truncate(self, minval=0.0, maxval=1.0, N=None):
         # http://stackoverflow.com/a/18926541/2121597
         if N is None:
             N = np.ceil(self.N * (maxval - minval))
-        name = "trunc({},{:.2f},{:.2f})".format(self.name, minval, maxval)
+        if name is None:
+            name = "trunc({},{:.2f},{:.2f})".format(self.name, minval, maxval)
         return ListedColormap(self(np.linspace(minval, maxval, N)), name)
 
 
