Skip to content

Commit 258de08

Browse files
committed
Rename corners -> extent
1 parent df56e67 commit 258de08

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

seaborn/_core/plot.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,7 @@ def layout(
810810
*,
811811
size: tuple[float, float] | Default = default,
812812
engine: str | None | Default = default,
813-
corners: tuple[float, float, float, float] | Default = default,
813+
extent: tuple[float, float, float, float] | Default = default,
814814
) -> Plot:
815815
"""
816816
Control the figure size and layout.
@@ -829,10 +829,10 @@ def layout(
829829
engine : {{"tight", "constrained", None}}
830830
Name of method for automatically adjusting the layout to remove overlap.
831831
The default depends on whether :meth:`Plot.on` is used.
832-
corners : (left, bottom, right, top)
833-
Position of the layout corners, in fractions of the figure size.
834-
Corners are inclusive of axis decorations when using a layout engine,
835-
but they are exclusive when `engine=None`.
832+
extent : (left, bottom, right, top)
833+
Boundaries of the plot layout, in fractions of the figure size.
834+
Note: the extent includes of axis decorations when using a layout engine,
835+
but it is exclusive when `engine=None`.
836836
837837
Examples
838838
--------
@@ -850,8 +850,8 @@ def layout(
850850
new._figure_spec["figsize"] = size
851851
if engine is not default:
852852
new._layout_spec["engine"] = engine
853-
if corners is not default:
854-
new._layout_spec["corners"] = corners
853+
if extent is not default:
854+
new._layout_spec["extent"] = extent
855855

856856
return new
857857

@@ -1810,13 +1810,13 @@ def _finalize_figure(self, p: Plot) -> None:
18101810
# TODO either way, make configurable
18111811
set_layout_engine(self._figure, "tight")
18121812

1813-
if (corners := p._layout_spec.get("corners")) is not None:
1813+
if (extent := p._layout_spec.get("extent")) is not None:
18141814
engine = self._figure.get_layout_engine()
18151815
if engine is None:
1816-
self._figure.subplots_adjust(*corners)
1816+
self._figure.subplots_adjust(*extent)
18171817
else:
18181818
# Note the different parameterization for the layout engine rect...
1819-
left, bottom, right, top = corners
1819+
left, bottom, right, top = extent
18201820
width, height = right - left, top - bottom
18211821
try:
18221822
# The base LayoutEngine.set method doesn't have rect= so we need

tests/_core/test_plot.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1091,19 +1091,19 @@ def test_layout_size(self):
10911091
p = Plot().layout(size=size).plot()
10921092
assert tuple(p._figure.get_size_inches()) == size
10931093

1094-
def test_layout_corners(self):
1094+
def test_layout_extent(self):
10951095

1096-
p = Plot().layout(corners=(.1, .2, .6, 1)).plot()
1096+
p = Plot().layout(extent=(.1, .2, .6, 1)).plot()
10971097
assert p._figure.get_layout_engine().get()["rect"] == [.1, .2, .5, .8]
10981098

1099-
def test_constrained_layout_corners(self):
1099+
def test_constrained_layout_extent(self):
11001100

1101-
p = Plot().layout(engine="constrained", corners=(.1, .2, .6, 1)).plot()
1101+
p = Plot().layout(engine="constrained", extent=(.1, .2, .6, 1)).plot()
11021102
assert p._figure.get_layout_engine().get()["rect"] == [.1, .2, .5, .8]
11031103

1104-
def test_base_layout_corners(self):
1104+
def test_base_layout_extent(self):
11051105

1106-
p = Plot().layout(engine=None, corners=(.1, .2, .6, 1)).plot()
1106+
p = Plot().layout(engine=None, extent=(.1, .2, .6, 1)).plot()
11071107
assert p._figure.subplotpars.left == 0.1
11081108
assert p._figure.subplotpars.right == 0.6
11091109
assert p._figure.subplotpars.bottom == 0.2

0 commit comments

Comments
 (0)