Merge pull request #7548 from anntzer/clarify-to_rgba-docstring

tacaswell · tacaswell · commit 56635c55e892 · 2016-12-04T16:58:26.000-05:00
DOC: Clarify to_rgba docstring.
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -121,7 +121,8 @@ def is_color_like(c):
 def to_rgba(c, alpha=None):
     """Convert `c` to an RGBA color.
 
-    If `alpha` is not `None`, it forces the alpha value.
+    If `alpha` is not `None`, it forces the alpha value, except if `c` is
+    "none" (case-insensitive), which always maps to `(0, 0, 0, 0)`.
     """
     # Special-case nth color syntax because it should not be cached.
     if _is_nth_color(c):
@@ -143,7 +144,8 @@ def to_rgba(c, alpha=None):
 def _to_rgba_no_colorcycle(c, alpha=None):
     """Convert `c` to an RGBA color, with no support for color-cycle syntax.
 
-    If `alpha` is not `None`, it forces the alpha value.
+    If `alpha` is not `None`, it forces the alpha value, except if `c` is
+    "none" (case-insensitive), which always maps to `(0, 0, 0, 0)`.
     """
     orig_c = c
     if isinstance(c, six.string_types):
