Merge pull request #10625 from anntzer/constrainedlayoutmarkup

jklymak · web-flow · commit bd8791de140a · 2018-02-27T22:18:38.000-08:00
Fixes to constrainedlayout tutorial markup.
diff --git a/tutorials/intermediate/constrainedlayout_guide.py b/tutorials/intermediate/constrainedlayout_guide.py
@@ -223,19 +223,19 @@ def example_plot(ax, fontsize=12, nodec=False):
         hspace=0.2, wspace=0.2)
 
 ##########################################
-# rcParams:
-# -----------
+# rcParams
+# --------
 #
 # There are five `rcParams` that can be set, either in a script
 # or in the `matplotlibrc` file.  They all have the prefix
 # `figure.constrained_layout`:
 #
-#  - `use`: Whether to use constrained_layout. Default is False
-#  - `w_pad`, `h_pad`    Padding around axes objects.
-#     Float representing inches.  Default is 3./72. inches (3 pts)
-#  - `wspace`, `hspace`  Space between subplot groups.
-#     Float representing a fraction of the subplot widths being separated.
-#     Default is 0.02.
+# - `use`: Whether to use constrained_layout. Default is False
+# - `w_pad`, `h_pad`    Padding around axes objects.
+#    Float representing inches.  Default is 3./72. inches (3 pts)
+# - `wspace`, `hspace`  Space between subplot groups.
+#    Float representing a fraction of the subplot widths being separated.
+#    Default is 0.02.
 
 plt.rcParams['figure.constrained_layout.use'] = True
 fig, axs = plt.subplots(2, 2, figsize=(3, 3))
@@ -446,16 +446,15 @@ def docomplicated(suptitle=None):
 # Other Caveats
 # -------------
 #
-#  * ``constrained_layout`` only considers ticklabels,
-#    axis labels, titles, and legends.  Thus, other artists may be clipped
-#    and also may overlap.
+# * ``constrained_layout`` only considers ticklabels, axis labels, titles, and
+#   legends.  Thus, other artists may be clipped and also may overlap.
 #
-#  * It assumes that the extra space needed for ticklabels, axis labels,
-#    and titles is independent of original location of axes. This is
-#    often true, but there are rare cases where it is not.
+# * It assumes that the extra space needed for ticklabels, axis labels,
+#   and titles is independent of original location of axes. This is
+#   often true, but there are rare cases where it is not.
 #
-#  * There are small differences in how the backends handle rendering fonts,
-#    so the results will not be pixel-identical.
+# * There are small differences in how the backends handle rendering fonts,
+#   so the results will not be pixel-identical.
 
 ###########################################################
 # Debugging
@@ -467,9 +466,9 @@ def docomplicated(suptitle=None):
 # mode is for all sizes to collapse to their smallest allowable value. If
 # this happens, it is for one of two reasons:
 #
-#   1. There was not enough room for the elements you were requesting to draw
-#   2. There is a bug - in which case open an issue at
-#      https://github.com/matplotlib/matplotlib/issues.
+# 1. There was not enough room for the elements you were requesting to draw.
+# 2. There is a bug - in which case open an issue at
+#    https://github.com/matplotlib/matplotlib/issues.
 #
 # If there is a bug, please report with a self-contained example that does
 # not require outside data or dependencies (other than numpy).
@@ -632,11 +631,10 @@ def docomplicated(suptitle=None):
 # height of the 1-row Axes to be less than half the height of the
 # 2-row Axes.
 #
-# ..note::
+# .. note::
 #
-#   This algorithm can be wrong if the decorations attached
-#   to the smaller axes are very large, so there is an unaccounted-for
-#   edge case.
+#    This algorithm can be wrong if the decorations attached to the smaller
+#    axes are very large, so there is an unaccounted-for edge case.
 
 
 fig = plt.figure(constrained_layout=True)
