Merge pull request #27164 from Borda/docs/set_facecolor

timhoffm · web-flow · commit 309981d6ae71 · 2023-10-26T20:11:04.000+02:00
docs: adding explanation for color in `set_facecolor`
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1499,7 +1499,7 @@ def set_facecolor(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color; see :ref:`colors_def`
         """
         self._facecolor = color
         self.stale = True
diff --git a/lib/matplotlib/axes/_secondary_axes.py b/lib/matplotlib/axes/_secondary_axes.py
@@ -233,7 +233,7 @@ def set_color(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color; see :ref:`colors_def`
         """
         axis = self._axis_map[self._orientation]
         axis.set_tick_params(colors=color)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -410,7 +410,7 @@ def set_edgecolor(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color; see :ref:`colors_def`
         """
         self.patch.set_edgecolor(color)
 
@@ -420,7 +420,7 @@ def set_facecolor(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color; see :ref:`colors_def`
         """
         self.patch.set_facecolor(color)
 
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -1056,7 +1056,7 @@ def set_color(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color; see :ref:`colors_def`
         """
         mcolors._check_color_like(color=color)
         self._color = color
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -332,7 +332,7 @@ def set_edgecolor(self, color):
 
         Parameters
         ----------
-        color : color or None
+        color : color or None; see :ref:`colors_def`
         """
         self._original_edgecolor = color
         self._set_edgecolor(color)
@@ -350,7 +350,7 @@ def set_facecolor(self, color):
 
         Parameters
         ----------
-        color : color or None
+        color : color or None; see :ref:`colors_def`
         """
         self._original_facecolor = color
         self._set_facecolor(color)
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -965,7 +965,7 @@ def set_backgroundcolor(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color; see :ref:`colors_def`
 
         See Also
         --------
@@ -985,7 +985,7 @@ def set_color(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color; see :ref:`colors_def`
         """
         # "auto" is only supported by axisartist, but we can just let it error
         # out at draw time for simplicity.
