From 1804254743f6b57b6ab85d263b83a6f9a4297456 Mon Sep 17 00:00:00 2001 From: haziq-khurshid Date: Sun, 14 Aug 2022 12:57:41 +0500 Subject: [PATCH 1/5] [Doc]: Document the position parameter in apply_aspect() #23583 --- lib/matplotlib/axes/_base.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index 91b5469ac057..9386bc5b9404 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -1859,6 +1859,12 @@ def apply_aspect(self, position=None): """ Adjust the Axes for a specified data aspect ratio. + Parameters + ---------- + position : None or .Bbox + Possible values: + - If not ``None`, this defines the position of the Axes within the figure as a Bbox. See `.get_position` for further details. + Depending on `.get_adjustable` this will modify either the Axes box (position) or the view limits. In the former case, `~matplotlib.axes.Axes.get_anchor` will affect the position. From fb9c0c86800f963e06a58f88da5e3226534dcb13 Mon Sep 17 00:00:00 2001 From: haziq-khurshid Date: Sun, 14 Aug 2022 13:10:47 +0500 Subject: [PATCH 2/5] [Doc]: Document the position parameter in apply_aspect() --- lib/matplotlib/axes/_base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index 9386bc5b9404..6b58cba86ee9 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -1862,8 +1862,8 @@ def apply_aspect(self, position=None): Parameters ---------- position : None or .Bbox - Possible values: - - If not ``None`, this defines the position of the Axes within the figure as a Bbox. See `.get_position` for further details. + If not ``None`, this defines the position of the Axes within the figure as a Bbox. + See `.get_position` for further details. Depending on `.get_adjustable` this will modify either the Axes box (position) or the view limits. In the former case, From f95e8b121a7c671d01a25c4895a234bdbdb88c02 Mon Sep 17 00:00:00 2001 From: haziq-khurshid Date: Sun, 14 Aug 2022 13:17:05 +0500 Subject: [PATCH 3/5] [Doc]: Document the position parameter in apply_aspect() --- lib/matplotlib/axes/_base.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index 6b58cba86ee9..1fedeb04996a 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -1862,8 +1862,9 @@ def apply_aspect(self, position=None): Parameters ---------- position : None or .Bbox - If not ``None`, this defines the position of the Axes within the figure as a Bbox. - See `.get_position` for further details. + If not ``None`, this defines the position of the + Axes within the figure as a Bbox. See `.get_position` + for further details. Depending on `.get_adjustable` this will modify either the Axes box (position) or the view limits. In the former case, From 168343c7a4ff25ce3500057db3f532cd096a2a09 Mon Sep 17 00:00:00 2001 From: haziq-khurshid Date: Sun, 14 Aug 2022 13:21:32 +0500 Subject: [PATCH 4/5] [Doc]: Document the position parameter in apply_aspect() --- lib/matplotlib/axes/_base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index 1fedeb04996a..86efb5f7b4ae 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -1865,7 +1865,7 @@ def apply_aspect(self, position=None): If not ``None`, this defines the position of the Axes within the figure as a Bbox. See `.get_position` for further details. - + Depending on `.get_adjustable` this will modify either the Axes box (position) or the view limits. In the former case, `~matplotlib.axes.Axes.get_anchor` will affect the position. From ce8ecaa16a4005867a575585c6ef27dab2529e4a Mon Sep 17 00:00:00 2001 From: haziq-khurshid Date: Sun, 14 Aug 2022 13:24:37 +0500 Subject: [PATCH 5/5] [Doc]: Document the position parameter in apply_aspect() --- lib/matplotlib/axes/_base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index 86efb5f7b4ae..f537530628a7 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -1862,7 +1862,7 @@ def apply_aspect(self, position=None): Parameters ---------- position : None or .Bbox - If not ``None`, this defines the position of the + If not ``None`, this defines the position of the Axes within the figure as a Bbox. See `.get_position` for further details.