From 58e8b948198206d30c139ce7aef306844e13d897 Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 26 Aug 2021 13:57:40 -0400 Subject: [PATCH 1/4] numpydoc style parameters and link to colors tutorial for colors.to_hex --- lib/matplotlib/colors.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py index f75e069d3083..2f78cdecde18 100644 --- a/lib/matplotlib/colors.py +++ b/lib/matplotlib/colors.py @@ -390,8 +390,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 ` 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: From a248e6097e3b1066dcfd44380896077a77f54e52 Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 26 Aug 2021 23:06:36 -0400 Subject: [PATCH 2/4] Update lib/matplotlib/colors.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> --- lib/matplotlib/colors.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py index 2f78cdecde18..efa9178abaff 100644 --- a/lib/matplotlib/colors.py +++ b/lib/matplotlib/colors.py @@ -394,9 +394,8 @@ def to_hex(c, keep_alpha=False): ---------- c : :doc:`color ` or ``np.ma.masked`` - keep_alpha: bool, optional - Uses the ``#rrggbb`` format if *keep_alpha* is False (the default), - otherwise uses ``#rrggbbaa``. + keep_alpha: bool, default: False + If False, use the ``#rrggbb`` format, otherwise use ``#rrggbbaa``. Returns ------- From 6529020c46e864dde83c1a112e2689a998ee9de0 Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 26 Aug 2021 23:07:42 -0400 Subject: [PATCH 3/4] Update lib/matplotlib/colors.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> --- lib/matplotlib/colors.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py index efa9178abaff..4dfd61b7ef01 100644 --- a/lib/matplotlib/colors.py +++ b/lib/matplotlib/colors.py @@ -392,7 +392,7 @@ def to_hex(c, keep_alpha=False): Parameters ---------- - c : :doc:`color ` or ``np.ma.masked`` + c : :doc:`color ` or `np.ma.masked` keep_alpha: bool, default: False If False, use the ``#rrggbb`` format, otherwise use ``#rrggbbaa``. From 143c30e27d1980c9d501ecd61d554a294535a11a Mon Sep 17 00:00:00 2001 From: hannah Date: Mon, 13 Sep 2021 10:31:14 -0400 Subject: [PATCH 4/4] Update lib/matplotlib/colors.py Co-authored-by: David Stansby --- lib/matplotlib/colors.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py index 4dfd61b7ef01..0af0fe52d4f4 100644 --- a/lib/matplotlib/colors.py +++ b/lib/matplotlib/colors.py @@ -392,7 +392,7 @@ def to_hex(c, keep_alpha=False): Parameters ---------- - c : :doc:`color ` or `np.ma.masked` + c : :doc:`color ` or `numpy.ma.masked` keep_alpha: bool, default: False If False, use the ``#rrggbb`` format, otherwise use ``#rrggbbaa``.