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 2b58748

Browse filesBrowse files
story645meeseeksmachine
authored andcommitted
Backport PR #27323: [DOC] Minor fixes for savefig-docstring
1 parent 94c0cfe commit 2b58748
Copy full SHA for 2b58748

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
@@ -3237,10 +3237,10 @@ def savefig(self, fname, *, transparent=None, **kwargs):
32373237
32383238
Call signature::
32393239
3240-
savefig(fname, *, dpi='figure', format=None, metadata=None,
3241-
bbox_inches=None, pad_inches=0.1,
3242-
facecolor='auto', edgecolor='auto',
3243-
backend=None, **kwargs
3240+
savefig(fname, *, transparent=None, dpi='figure', format=None,
3241+
metadata=None, bbox_inches=None, pad_inches=0.1,
3242+
facecolor='auto', edgecolor='auto', backend=None,
3243+
**kwargs
32443244
)
32453245
32463246
The available output formats depend on the backend being used.
@@ -3265,6 +3265,22 @@ def savefig(self, fname, *, transparent=None, **kwargs):
32653265
32663266
Other Parameters
32673267
----------------
3268+
transparent : bool, default: :rc:`savefig.transparent`
3269+
If *True*, the Axes patches will all be transparent; the
3270+
Figure patch will also be transparent unless *facecolor*
3271+
and/or *edgecolor* are specified via kwargs.
3272+
3273+
If *False* has no effect and the color of the Axes and
3274+
Figure patches are unchanged (unless the Figure patch
3275+
is specified via the *facecolor* and/or *edgecolor* keyword
3276+
arguments in which case those colors are used).
3277+
3278+
The transparency of these patches will be restored to their
3279+
original values upon exit of this function.
3280+
3281+
This is useful, for example, for displaying
3282+
a plot on top of a colored background on a web page.
3283+
32683284
dpi : float or 'figure', default: :rc:`savefig.dpi`
32693285
The resolution in dots per inch. If 'figure', use the figure's
32703286
dpi value.
@@ -3324,22 +3340,6 @@ def savefig(self, fname, *, transparent=None, **kwargs):
33243340
'a10', 'b0' through 'b10'. Only supported for postscript
33253341
output.
33263342
3327-
transparent : bool
3328-
If *True*, the Axes patches will all be transparent; the
3329-
Figure patch will also be transparent unless *facecolor*
3330-
and/or *edgecolor* are specified via kwargs.
3331-
3332-
If *False* has no effect and the color of the Axes and
3333-
Figure patches are unchanged (unless the Figure patch
3334-
is specified via the *facecolor* and/or *edgecolor* keyword
3335-
arguments in which case those colors are used).
3336-
3337-
The transparency of these patches will be restored to their
3338-
original values upon exit of this function.
3339-
3340-
This is useful, for example, for displaying
3341-
a plot on top of a colored background on a web page.
3342-
33433343
bbox_extra_artists : list of `~matplotlib.artist.Artist`, optional
33443344
A list of extra artists that will be considered when the
33453345
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.