Skip to content

docs: adding explanation for color in set_facecolor #27164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timhoffm merged 2 commits into from
Oct 26, 2023
Merged

docs: adding explanation for color in set_facecolor #27164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbbbc53
docs: adding explanation for color in `set_facecolor`
Borda Oct 21, 2023
3bd5672
suggestion
Borda Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/matplotlib/axes/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1499,7 +1499,7 @@ def set_facecolor(self, color):

Parameters
----------
color : color
color : color; see :ref:`colors_def`
"""
self._facecolor = color
self.stale = True
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/axes/_secondary_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ def set_edgecolor(self, color):

Parameters
----------
color : color
color : color; see :ref:`colors_def`
"""
self.patch.set_edgecolor(color)

Expand All @@ -420,7 +420,7 @@ def set_facecolor(self, color):

Parameters
----------
color : color
color : color; see :ref:`colors_def`
"""
self.patch.set_facecolor(color)

Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/lines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/patches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -965,7 +965,7 @@ def set_backgroundcolor(self, color):

Parameters
----------
color : color
color : color; see :ref:`colors_def`

See Also
--------
Expand All @@ -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.
Expand Down