From 07d2c3592a8afeeb09cc337dd36e72a6c7ce6913 Mon Sep 17 00:00:00 2001 From: DangoMelon Date: Sat, 11 Jul 2020 12:23:03 -0500 Subject: [PATCH 1/3] Minor docs fixes --- examples/axes_grid1/inset_locator_demo.py | 2 +- examples/lines_bars_and_markers/fill.py | 2 +- examples/mplot3d/voxels_torus.py | 2 +- lib/matplotlib/_constrained_layout.py | 13 ++++++------- 4 files changed, 9 insertions(+), 10 deletions(-) diff --git a/examples/axes_grid1/inset_locator_demo.py b/examples/axes_grid1/inset_locator_demo.py index 5fd0bc926794..64f49c1210a2 100644 --- a/examples/axes_grid1/inset_locator_demo.py +++ b/examples/axes_grid1/inset_locator_demo.py @@ -44,7 +44,7 @@ ############################################################################### -# The arguments *bbox_to_anchor* and *bbox_transfrom* can be used for a more +# The parameters *bbox_to_anchor* and *bbox_transfrom* can be used for a more # fine grained control over the inset position and size or even to position # the inset at completely arbitrary positions. # The *bbox_to_anchor* sets the bounding box in coordinates according to the diff --git a/examples/lines_bars_and_markers/fill.py b/examples/lines_bars_and_markers/fill.py index f254949cd212..c6c72715e53d 100644 --- a/examples/lines_bars_and_markers/fill.py +++ b/examples/lines_bars_and_markers/fill.py @@ -20,7 +20,7 @@ def koch_snowflake(order, scale=10): """ Return two lists x, y of point coordinates of the Koch snowflake. - Arguments + Parameters --------- order : int The recursion depth. diff --git a/examples/mplot3d/voxels_torus.py b/examples/mplot3d/voxels_torus.py index dd21cf3af103..11b5a0b05f62 100644 --- a/examples/mplot3d/voxels_torus.py +++ b/examples/mplot3d/voxels_torus.py @@ -3,7 +3,7 @@ 3D voxel / volumetric plot with cylindrical coordinates ======================================================= -Demonstrates using the *x*, *y*, *z* arguments of `.Axes3D.voxels`. +Demonstrates using the *x*, *y*, *z* parameters of `.Axes3D.voxels`. """ import matplotlib.pyplot as plt diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py index 90faebc1525a..6d13a850bc43 100644 --- a/lib/matplotlib/_constrained_layout.py +++ b/lib/matplotlib/_constrained_layout.py @@ -77,17 +77,16 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad, Parameters ---------- fig : Figure - is the ``figure`` instance to do the layout in. + ``Figure`` instance to do the layout in. renderer : Renderer - the renderer to use. + Renderer to use. - h_pad, w_pad : float - are in figure-normalized units, and are a padding around the axes - elements. + h_pad, w_pad : float + Padding around the axes elements in figure-normalized units. - hspace, wspace : float - are in fractions of the subplot sizes. + hspace, wspace : float + Spacing in fractions of the subplot sizes. """ From aeeddc5c426aa31973cb82dbb53c9aee0926ff3d Mon Sep 17 00:00:00 2001 From: DangoMelon Date: Sat, 11 Jul 2020 15:51:02 -0500 Subject: [PATCH 2/3] Add missing dash --- examples/lines_bars_and_markers/fill.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/lines_bars_and_markers/fill.py b/examples/lines_bars_and_markers/fill.py index c6c72715e53d..e6d2e4293f35 100644 --- a/examples/lines_bars_and_markers/fill.py +++ b/examples/lines_bars_and_markers/fill.py @@ -21,7 +21,7 @@ def koch_snowflake(order, scale=10): Return two lists x, y of point coordinates of the Koch snowflake. Parameters - --------- + ---------- order : int The recursion depth. scale : float From 3e5ef861cd8f28643db2604e7cbe120e39b88d95 Mon Sep 17 00:00:00 2001 From: DangoMelon Date: Sat, 11 Jul 2020 15:57:58 -0500 Subject: [PATCH 3/3] Correct a typo --- examples/axes_grid1/inset_locator_demo.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/axes_grid1/inset_locator_demo.py b/examples/axes_grid1/inset_locator_demo.py index 64f49c1210a2..56b5a8357e10 100644 --- a/examples/axes_grid1/inset_locator_demo.py +++ b/examples/axes_grid1/inset_locator_demo.py @@ -44,7 +44,7 @@ ############################################################################### -# The parameters *bbox_to_anchor* and *bbox_transfrom* can be used for a more +# The parameters *bbox_to_anchor* and *bbox_transform* can be used for a more # fine grained control over the inset position and size or even to position # the inset at completely arbitrary positions. # The *bbox_to_anchor* sets the bounding box in coordinates according to the