DOC: fix formatting and typos

tacaswell · QuLogic · web-flow · commit d58647bd4778 · 2020-11-11T14:35:41.000-05:00
Co-authored-by: Elliott Sales de Andrade &lt;quantum.analyst@gmail.com&gt;
diff --git a/lib/mpl_toolkits/mplot3d/art3d.py b/lib/mpl_toolkits/mplot3d/art3d.py
@@ -642,8 +642,8 @@ def do_3d_projection(self, renderer=None):
 
 
 def _update_scalarmappable(sm):
-
-    """Update a 3D ScalarMappable.
+    """
+    Update a 3D ScalarMappable.
 
     With ScalarMappable objects if the data, colormap, or norm are
     changed, we need to update the computed colors.  This is handled
@@ -657,40 +657,40 @@ def _update_scalarmappable(sm):
     handled in the ``do_3d_projection`` methods which are called from the
     draw method of the 3D Axes.  These methods:
 
-     - do the projection from 3D -> 2D
-     - internally sort based on depth
-     - stash the results of the above in the 2D analogs of state
-     - return the z-depth of the whole artist
+    - do the projection from 3D -> 2D
+    - internally sort based on depth
+    - stash the results of the above in the 2D analogs of state
+    - return the z-depth of the whole artist
 
     the last step is so that we can, at the Axes level, sort the children by
     depth.
 
-    The base `draw` method of the 2D artists unconditionally call
+    The base `draw` method of the 2D artists unconditionally calls
     update_scalarmappable and rely on the method's internal caching logic to
     lazily evaluate.
 
     These things together mean you can have the sequence of events:
 
-    - we create the artist, to the color mapping and stash the results in a 3D
+    - we create the artist, do the color mapping and stash the results in a 3D
       specific state.
     - change something about the ScalarMappable that marks it as in need of an
       update (`ScalarMappable.changed` and friends).
     - We call do_3d_projection and shuffle the stashed colors into the 2D version
       of face colors
     - the draw method calls the update_scalarmappable method which overwrites our
       shuffled colors
-    - we get a render this is wrong
+    - we get a render that is wrong
     - if we re-render (either with a second save or implicitly via
-      tight_layout / constairned_layout / bbox_inches='tight' (ex via
+      tight_layout / constrained_layout / bbox_inches='tight' (ex via
       inline's defaults)) we again shuffle the 3D colors
     - because the CM is not marked as changed update_scalarmappable is a no-op and
       we get a correct looking render.
 
     This function is an internal helper to:
 
-     - sort out if we need to do the color mapping at all (has data!)
-     - sort out if update_scalarmappable is going to be a no-op
-     - copy the data over from the 2D -> 3D version
+    - sort out if we need to do the color mapping at all (has data!)
+    - sort out if update_scalarmappable is going to be a no-op
+    - copy the data over from the 2D -> 3D version
 
     This must be called first thing in do_3d_projection to make sure that
     the correct colors get shuffled.
diff --git a/lib/mpl_toolkits/tests/test_mplot3d.py b/lib/mpl_toolkits/tests/test_mplot3d.py
@@ -1318,7 +1318,7 @@ def test_scalarmap_update(fig_test, fig_ref):
     sc_test = ax_test.scatter(x, y, z, c=c, s=40, cmap='viridis')
     # force a draw
     fig_test.canvas.draw()
-    # make it as "stale"
+    # mark it as "stale"
     sc_test.changed()
 
     # ref
