Skip to content

Fix some backend_bases docstrings. #13219

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
merged 1 commit into from
Jan 19, 2019
Merged

Fix some backend_bases docstrings. #13219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 9 additions & 6 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -923,11 +923,14 @@ def set_dashes(self, dash_offset, dash_list):

def set_foreground(self, fg, isRGBA=False):
"""
Set the foreground color. fg can be a MATLAB format string, a
html hex color string, an rgb or rgba unit tuple, or a float between 0
and 1. In the latter case, grayscale is used.
Set the foreground color.

If you know fg is rgba, set ``isRGBA=True`` for efficiency.
Parameters
----------
fg : color
isRGBA : bool
If *fg* is known to be an ``(r, g, b, a)`` tuple, *isRGBA* can be
set to True to improve performance.
"""
if self._forced_alpha and isRGBA:
self._rgb = fg[:3] + (self._alpha,)
Expand Down Expand Up @@ -1899,10 +1902,10 @@ def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
dpi : scalar, optional
the dots per inch to save the figure in; if None, use savefig.dpi

facecolor : color spec or None, optional
facecolor : color or None, optional
the facecolor of the figure; if None, defaults to savefig.facecolor

edgecolor : color spec or None, optional
edgecolor : color or None, optional
the edgecolor of the figure; if None, defaults to savefig.edgecolor

format : str, optional
Expand Down