MNT: suggestions from review

tacaswell · QuLogic · tacaswell · commit d48b87cd9a89 · 2020-06-01T23:42:57.000-04:00
Co-authored-by: Elliott Sales de Andrade &lt;quantum.analyst@gmail.com&gt;
diff --git a/doc/users/next_whats_new/2019-03-25-mplot3d-projection.rst b/doc/users/next_whats_new/2019-03-25-mplot3d-projection.rst
@@ -8,9 +8,9 @@ bounding boxes were used.  As of 3.3, this no longer occurs.
 
 Currently modes of setting the aspect (via
 `~mpl_toolkits.mplot3d.axes3d.Axes3D.set_aspect`), in data space, are
-not supported for Axes3D but maybe in the future.  If you want to
+not supported for Axes3D but may be in the future.  If you want to
 simulate having equal aspect in data space, set the ratio of your data
 limits to match the value of `~.get_box_aspect`.  To control these
 ratios use the `~mpl_toolkits.mplot3d.axes3d.Axes3D.set_box_aspect`
-method which accepts th ratios at as a 3-tuple of X:Y:Z.  The default
+method which accepts th ratios as a 3-tuple of X:Y:Z.  The default
 aspect ratio is 4:4:3.
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -349,14 +349,17 @@ def set_anchor(self, anchor, share=False):
             ax._anchor = anchor
             ax.stale = True
 
-    def set_box_aspect(self, aspect, zoom=1):
+    def set_box_aspect(self, aspect, *, zoom=1):
         """
         Set the axes box aspect.
 
         The box aspect is the ratio of the axes height to the axes width in
         physical units. This is not to be confused with the data
         aspect, set via `~.Axes.set_aspect`.
 
+        The *zoom* is a Axes3D only parameter that controls the overall
+        size of the Axes3D in the figure.
+
         Parameters
         ----------
         aspect : 3-tuple of floats on None
@@ -370,7 +373,7 @@ def set_box_aspect(self, aspect, zoom=1):
                 ax.set_box_aspect(aspect=(4, 4, 3), zoom=1)
 
         zoom : float
-            Control the "zoom" of the
+            Control overall size of the Axes3D in the figure.
 
         See Also
         --------
@@ -381,7 +384,7 @@ def set_box_aspect(self, aspect, zoom=1):
             aspect = zoom * np.asarray((4, 4, 3)) / 3.5
         else:
             aspect = np.asarray(aspect, dtype=float)
-            # default scale tuned to match the
+            # default scale tuned to match the mpl32 appearance.
             aspect *= 1.829 * zoom / np.linalg.norm(aspect)
 
         self._box_aspect = aspect
@@ -391,8 +394,6 @@ def apply_aspect(self, position=None):
         if position is None:
             position = self.get_position(original=True)
 
-        aspect = self.get_aspect()
-
         # in the superclass, we would go through and actually deal with axis
         # scales and box/datalim. Those are all irrelevant - all we need to do
         # is make sure our coordinate system is square.
@@ -463,7 +464,6 @@ def get_axis_position(self):
         return xhigh, yhigh, zhigh
 
     def _on_units_changed(self, scalex=False, scaley=False, scalez=False):
-
         """
         Callback for processing changes to axis units.
 
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -3,6 +3,7 @@
 # Parts rewritten by Reinier Heeres <reinier@heeres.eu>
 
 import numpy as np
+
 import matplotlib.transforms as mtransforms
 from matplotlib import (
     artist, lines as mlines, axis as maxis, patches as mpatches, rcParams)
diff --git a/lib/mpl_toolkits/tests/test_mplot3d.py b/lib/mpl_toolkits/tests/test_mplot3d.py
@@ -975,7 +975,7 @@ def test_equal_box_aspect():
     v = np.linspace(0, np.pi, 100)
     x = np.outer(np.cos(u), np.sin(v))
     y = np.outer(np.sin(u), np.sin(v))
-    z = np.outer(np.ones(np.size(u)), np.cos(v))
+    z = np.outer(np.ones_like(u), np.cos(v))
 
     # Plot the surface
     ax.plot_surface(x, y, z)
@@ -987,7 +987,9 @@ def test_equal_box_aspect():
             ax.plot3D(*zip(s, e), color="b")
 
     # Make axes limits
-    xyzlim = np.array([ax.get_xlim3d(), ax.get_ylim3d(), ax.get_zlim3d()]).T
+    xyzlim = np.column_stack(
+        [ax.get_xlim3d(), ax.get_ylim3d(), ax.get_zlim3d()]
+    )
     XYZlim = [min(xyzlim[0]), max(xyzlim[1])]
     ax.set_xlim3d(XYZlim)
     ax.set_ylim3d(XYZlim)
