numpydoc style parameters and link to colors tutorial for colors.to_hex

story645 · story645 · commit 73db5b53d295 · 2021-08-26T15:01:03.000-04:00
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -29,7 +29,8 @@
 The module also provides functions for checking whether an object can be
 interpreted as a color (`is_color_like`), for converting such an object
 to an RGBA tuple (`to_rgba`) or to an HTML-like hex string in the
-"#rrggbb" format (`to_hex`), and a sequence of colors to an (n, 4)
+"#rrggbb" format (`
+`), and a sequence of colors to an (n, 4)
 RGBA array (`to_rgba_array`).  Caching is used for efficiency.
 
 Colors that Matplotlib recognizes are listed at
@@ -390,8 +391,18 @@ def to_hex(c, keep_alpha=False):
     """
     Convert *c* to a hex color.
 
-    Uses the ``#rrggbb`` format if *keep_alpha* is False (the default),
-    ``#rrggbbaa`` otherwise.
+    Parameters
+    ----------
+    c : :doc:`color </tutorials/colors/colors>` or ``np.ma.masked``
+
+    keep_alpha: bool, optional
+      Uses the ``#rrggbb`` format if *keep_alpha* is False (the default),
+      otherwise uses ``#rrggbbaa``.
+
+    Returns
+    -------
+    str
+      ``#rrggbb`` or ``#rrggbbaa`` hex color string
     """
     c = to_rgba(c)
     if not keep_alpha:
