Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit ced4405

Browse filesBrowse files
authored
Merge pull request #27323 from oscargus/savefigdoc
[DOC] Minor fixes for savefig-docstring
2 parents 6cc36ef + 63b064a commit ced4405
Copy full SHA for ced4405

File tree

Expand file treeCollapse file tree

1 file changed

+20
-20
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+20
-20
lines changed

‎lib/matplotlib/figure.py

Copy file name to clipboardExpand all lines: lib/matplotlib/figure.py
+20-20Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3186,10 +3186,10 @@ def savefig(self, fname, *, transparent=None, **kwargs):
31863186
31873187
Call signature::
31883188
3189-
savefig(fname, *, dpi='figure', format=None, metadata=None,
3190-
bbox_inches=None, pad_inches=0.1,
3191-
facecolor='auto', edgecolor='auto',
3192-
backend=None, **kwargs
3189+
savefig(fname, *, transparent=None, dpi='figure', format=None,
3190+
metadata=None, bbox_inches=None, pad_inches=0.1,
3191+
facecolor='auto', edgecolor='auto', backend=None,
3192+
**kwargs
31933193
)
31943194
31953195
The available output formats depend on the backend being used.
@@ -3214,6 +3214,22 @@ def savefig(self, fname, *, transparent=None, **kwargs):
32143214
32153215
Other Parameters
32163216
----------------
3217+
transparent : bool, default: :rc:`savefig.transparent`
3218+
If *True*, the Axes patches will all be transparent; the
3219+
Figure patch will also be transparent unless *facecolor*
3220+
and/or *edgecolor* are specified via kwargs.
3221+
3222+
If *False* has no effect and the color of the Axes and
3223+
Figure patches are unchanged (unless the Figure patch
3224+
is specified via the *facecolor* and/or *edgecolor* keyword
3225+
arguments in which case those colors are used).
3226+
3227+
The transparency of these patches will be restored to their
3228+
original values upon exit of this function.
3229+
3230+
This is useful, for example, for displaying
3231+
a plot on top of a colored background on a web page.
3232+
32173233
dpi : float or 'figure', default: :rc:`savefig.dpi`
32183234
The resolution in dots per inch. If 'figure', use the figure's
32193235
dpi value.
@@ -3273,22 +3289,6 @@ def savefig(self, fname, *, transparent=None, **kwargs):
32733289
'a10', 'b0' through 'b10'. Only supported for postscript
32743290
output.
32753291
3276-
transparent : bool
3277-
If *True*, the Axes patches will all be transparent; the
3278-
Figure patch will also be transparent unless *facecolor*
3279-
and/or *edgecolor* are specified via kwargs.
3280-
3281-
If *False* has no effect and the color of the Axes and
3282-
Figure patches are unchanged (unless the Figure patch
3283-
is specified via the *facecolor* and/or *edgecolor* keyword
3284-
arguments in which case those colors are used).
3285-
3286-
The transparency of these patches will be restored to their
3287-
original values upon exit of this function.
3288-
3289-
This is useful, for example, for displaying
3290-
a plot on top of a colored background on a web page.
3291-
32923292
bbox_extra_artists : list of `~matplotlib.artist.Artist`, optional
32933293
A list of extra artists that will be considered when the
32943294
tight bbox is calculated.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.