@@ -2475,7 +2475,7 @@ def __init__(self,
2475
2475
2476
2476
- 'tight': Use the tight layout mechanism. This is a relatively
2477
2477
simple algorithm that adjusts the subplot parameters so that
2478
- decorations do not overlap. See `.Figure. set_tight_layout` for
2478
+ decorations do not overlap. See `.set_tight_layout` for
2479
2479
further details.
2480
2480
2481
2481
- 'none': Do not use a layout engine.
@@ -2618,8 +2618,7 @@ def set_layout_engine(self, layout=None, **kwargs):
2618
2618
2619
2619
Parameters
2620
2620
----------
2621
- layout: {'constrained', 'compressed', 'tight', 'none'} or \
2622
- `LayoutEngine` or None
2621
+ layout : {'constrained', 'compressed', 'tight', 'none', `.LayoutEngine`, None}
2623
2622
2624
2623
- 'constrained' will use `~.ConstrainedLayoutEngine`
2625
2624
- 'compressed' will also use `~.ConstrainedLayoutEngine`, but with
@@ -2628,6 +2627,8 @@ def set_layout_engine(self, layout=None, **kwargs):
2628
2627
- 'tight' uses `~.TightLayoutEngine`
2629
2628
- 'none' removes layout engine.
2630
2629
2630
+ If a `.LayoutEngine` instance, that instance will be used.
2631
+
2631
2632
If `None`, the behavior is controlled by :rc:`figure.autolayout`
2632
2633
(which if `True` behaves as if 'tight' was passed) and
2633
2634
:rc:`figure.constrained_layout.use` (which if `True` behaves as if
@@ -2637,7 +2638,7 @@ def set_layout_engine(self, layout=None, **kwargs):
2637
2638
Users and libraries can define their own layout engines and pass
2638
2639
the instance directly as well.
2639
2640
2640
- kwargs: dict
2641
+ kwargs : dict
2641
2642
The keyword arguments are passed to the layout engine to set things
2642
2643
like padding and margin sizes. Only used if *layout* is a string.
2643
2644
0 commit comments