@@ -2172,31 +2172,26 @@ def __init__(self,
21722172 """
21732173 Parameters
21742174 ----------
2175- figsize : 2-tuple of floats, default: :rc:`figure.figsize`
2176- Figure dimension ``(width, height)`` in inches.
2175+ figsize : 2-tuple of floats, default: :rc:`figure.figsize` Figure
2176+ dimension ``(width, height)`` in inches.
21772177
2178- dpi : float, default: :rc:`figure.dpi`
2179- Dots per inch.
2178+ dpi : float, default: :rc:`figure.dpi` Dots per inch.
21802179
2181- facecolor : default: :rc:`figure.facecolor`
2182- The figure patch facecolor.
2180+ facecolor : default: :rc:`figure.facecolor` The figure patch facecolor.
21832181
2184- edgecolor : default: :rc:`figure.edgecolor`
2185- The figure patch edge color.
2182+ edgecolor : default: :rc:`figure.edgecolor` The figure patch edge color.
21862183
2187- linewidth : float
2188- The linewidth of the frame (i.e. the edge linewidth of the figure
2189- patch).
2184+ linewidth : float The linewidth of the frame (i.e. the edge linewidth of
2185+ the figure patch).
21902186
2191- frameon : bool, default: :rc:`figure.frameon`
2192- If ``False``, suppress drawing the figure background patch.
2187+ frameon : bool, default: :rc:`figure.frameon` If ``False``, suppress
2188+ drawing the figure background patch.
21932189
2194- subplotpars : `SubplotParams`
2195- Subplot parameters. If not given, the default subplot
2196- parameters :rc:`figure.subplot.*` are used.
2190+ subplotpars : `SubplotParams` Subplot parameters. If not given, the
2191+ default subplot parameters :rc:`figure.subplot.*` are used.
21972192
2198- tight_layout : bool or dict, default: :rc:`figure.autolayout`
2199- Whether to use the tight layout mechanism. See `.set_tight_layout`.
2193+ tight_layout : bool or dict, default: :rc:`figure.autolayout` Whether to
2194+ use the tight layout mechanism. See `.set_tight_layout`.
22002195
22012196 .. admonition:: Discouraged
22022197
@@ -2212,22 +2207,25 @@ def __init__(self,
22122207 The use of this parameter is discouraged. Please use
22132208 ``layout='constrained'`` instead.
22142209
2215- layout : {'constrained', 'tight'}, optional
2216- The layout mechanism for positioning of plot elements.
2210+ layout : {'constrained', 'tight'}, optional, default: None
2211+ The layout mechanism for positioning of plot elements to avoid
2212+ overlapping Axes decorations (labels, ticks, etc). Note that
2213+ layout managers can have significant performance penalties as
2214+ they require an extra draw and solve an inverse problem.
2215+
22172216 Supported values:
22182217
2219- - 'constrained': The constrained layout solver usually gives the
2220- best layout results and is thus recommended. However, it is
2221- computationally expensive and can be slow for complex figures
2222- with many elements.
2218+ - 'constrained': The constrained layout solver adjusts axes sizes
2219+ to avoid overlapping axes decorations. Can handle complex plot
2220+ layouts and colorbars, and is thus recommended.
22232221
22242222 See :doc:`/tutorials/intermediate/constrainedlayout_guide`
22252223 for examples.
22262224
22272225 - 'tight': Use the tight layout mechanism. This is a relatively
2228- simple algorithm, that adjusts the subplot parameters so that
2229- decorations like tick labels, axis labels and titles have enough
2230- space. See `.Figure.set_tight_layout` for further details.
2226+ simple algorithm that adjusts the subplot parameters so that
2227+ decorations do not overlap. See `.Figure.set_tight_layout` for
2228+ further details.
22312229
22322230 If not given, fall back to using the parameters *tight_layout* and
22332231 *constrained_layout*, including their config defaults
0 commit comments