Merge pull request #25718 from oscargus/colortypes

ksunden · web-flow · commit 7103779ae295 · 2023-04-18T12:13:33.000-05:00
Improve color documentation and typing
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1047,9 +1047,9 @@ def hlines(self, y, xmin, xmax, colors=None, linestyles='solid',
             Respective beginning and end of each line. If scalars are
             provided, all lines will have the same length.
 
-        colors : list of colors, default: :rc:`lines.color`
+        colors : color or list of colors, default: :rc:`lines.color`
 
-        linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
+        linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, default: 'solid'
 
         label : str, default: ''
 
@@ -1127,9 +1127,9 @@ def vlines(self, x, ymin, ymax, colors=None, linestyles='solid',
             Respective beginning and end of each line. If scalars are
             provided, all lines will have the same length.
 
-        colors : list of colors, default: :rc:`lines.color`
+        colors : color or list of colors, default: :rc:`lines.color`
 
-        linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
+        linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, default: 'solid'
 
         label : str, default: ''
 
@@ -3072,7 +3072,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
         labels : list, default: None
             A sequence of strings providing the labels for each wedge
 
-        colors : array-like, default: None
+        colors : color or array-like of color, default: None
             A sequence of colors through which the pie chart will cycle.  If
             *None*, will use the colors in the currently active cycle.
 
diff --git a/lib/matplotlib/axes/_axes.pyi b/lib/matplotlib/axes/_axes.pyi
@@ -163,7 +163,7 @@ class Axes(_AxesBase):
         y: float | ArrayLike,
         xmin: float | ArrayLike,
         xmax: float | ArrayLike,
-        colors: Sequence[ColorType] | None = ...,
+        colors: ColorType | Sequence[ColorType] | None = ...,
         linestyles: LineStyleType = ...,
         label: str = ...,
         **kwargs
@@ -173,7 +173,7 @@ class Axes(_AxesBase):
         x: float | ArrayLike,
         ymin: float | ArrayLike,
         ymax: float | ArrayLike,
-        colors: Sequence[ColorType] | None = ...,
+        colors: ColorType | Sequence[ColorType] | None = ...,
         linestyles: LineStyleType = ...,
         label: str = ...,
         **kwargs
@@ -287,7 +287,7 @@ class Axes(_AxesBase):
         x: ArrayLike,
         explode: ArrayLike | None = ...,
         labels: Sequence[str] | None = ...,
-        colors: Sequence[ColorType] | None = ...,
+        colors: ColorType | Sequence[ColorType] | None = ...,
         autopct: str | Callable[[float], str] | None = ...,
         pctdistance: float = ...,
         shadow: bool = ...,
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -3207,7 +3207,7 @@ def hlines(
     y: float | ArrayLike,
     xmin: float | ArrayLike,
     xmax: float | ArrayLike,
-    colors: Sequence[ColorType] | None = None,
+    colors: ColorType | Sequence[ColorType] | None = None,
     linestyles: LineStyleType = "solid",
     label: str = "",
     *,
@@ -3430,7 +3430,7 @@ def pie(
     x: ArrayLike,
     explode: ArrayLike | None = None,
     labels: Sequence[str] | None = None,
-    colors: Sequence[ColorType] | None = None,
+    colors: ColorType | Sequence[ColorType] | None = None,
     autopct: str | Callable[[float], str] | None = None,
     pctdistance: float = 0.6,
     shadow: bool = False,
@@ -3966,7 +3966,7 @@ def vlines(
     x: float | ArrayLike,
     ymin: float | ArrayLike,
     ymax: float | ArrayLike,
-    colors: Sequence[ColorType] | None = None,
+    colors: ColorType | Sequence[ColorType] | None = None,
     linestyles: LineStyleType = "solid",
     label: str = "",
     *,
