Clean up 3d plot box_aspect zooming

scottshambaugh · scottshambaugh · commit 90bce732b657 · 2022-01-04T13:30:35.000-07:00
linting

Cleanup
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -346,22 +346,25 @@ def set_box_aspect(self, aspect, *, zoom=1):
 
         Parameters
         ----------
-        aspect : 3-tuple of floats or None
+        aspect : 3-tuple of floats or None, default: None
             Changes the physical dimensions of the Axes3D, such that the ratio
             of the axis lengths in display units is x:y:z.
+            If None, defaults to (4,4,3)
 
-            If None, defaults to 4:4:3
-
-        zoom : float
+        zoom : float, default: 1
             Control overall size of the Axes3D in the figure.
         """
+        if zoom <= 0:
+            raise ValueError(f'Argument zoom = {zoom} must be > 0')
+        self.zoom = zoom
+
         if aspect is None:
             aspect = np.asarray((4, 4, 3), dtype=float)
         else:
             aspect = np.asarray(aspect, dtype=float)
             _api.check_shape((3,), aspect=aspect)
         # default scale tuned to match the mpl32 appearance.
-        aspect *= 1.8294640721620434 * zoom / np.linalg.norm(aspect)
+        aspect *= 1.8294640721620434 * self.zoom / np.linalg.norm(aspect)
 
         self._box_aspect = aspect
         self.stale = True
@@ -1006,7 +1009,7 @@ def view_init(self, elev=None, azim=None, roll=None, vertical_axis="z"):
             The axis to align vertically. *azim* rotates about this axis.
         """
 
-        self.dist = 10
+        self.dist = 10  # The camera distance from origin. Behaves like zoom
 
         if elev is None:
             self.elev = self.initial_elev
