Parameter checks and documentation updates.

tfpf · tfpf · commit 6b3b81544215 · 2022-08-04T18:08:08.000+05:30
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -287,12 +287,9 @@ def set_aspect(self, aspect, adjustable='datalim', anchor=None,
             'equalyz'   adapt the y and z axes to have equal aspect ratios.
             =========   ==================================================
 
-        adjustable : None
-            Currently ignored by Axes3D
-
-            If not *None*, this defines which parameter will be adjusted to
-            meet the required aspect. See `.set_adjustable` for further
-            details.
+        adjustable : {'datalim', 'box'}, default: 'datalim'
+            This defines which parameter will be adjusted to meet the required
+            aspect. See `.set_adjustable` for further details.
 
         anchor : None or str or 2-tuple of float, optional
             If not *None*, this defines where the Axes will be drawn if there
@@ -320,6 +317,7 @@ def set_aspect(self, aspect, adjustable='datalim', anchor=None,
         """
         _api.check_in_list(('auto', 'equal', 'equalxy', 'equalyz', 'equalxz'),
                            aspect=aspect)
+        _api.check_in_list(('datalim', 'box'), adjustable=adjustable)
         super().set_aspect(
             aspect='auto', adjustable=adjustable, anchor=anchor, share=share)
         self._aspect = aspect
@@ -337,9 +335,9 @@ def set_aspect(self, aspect, adjustable='datalim', anchor=None,
             view_intervals = np.array([self.xaxis.get_view_interval(),
                                        self.yaxis.get_view_interval(),
                                        self.zaxis.get_view_interval()])
+            ptp = np.ptp(view_intervals, axis=1)
             if adjustable == 'datalim':
                 mean = np.mean(view_intervals, axis=1)
-                ptp = np.ptp(view_intervals, axis=1)
                 delta = max(ptp[ax_indices])
                 scale = self._box_aspect[ptp == delta][0]
                 deltas = delta * self._box_aspect / scale
@@ -349,18 +347,17 @@ def set_aspect(self, aspect, adjustable='datalim', anchor=None,
                                              self.set_zlim3d)):
                     if i in ax_indices:
                         set_lim(mean[i] - deltas[i]/2., mean[i] + deltas[i]/2.)
-            elif adjustable == 'box':
+            else:  # 'box'
                 # Change the box aspect such that the ratio of the length of
                 # the unmodified axis to the length of the diagonal
                 # perpendicular to it remains unchanged.
-                deltas = np.ptp(view_intervals, axis=1)
-                box_aspect = np.array(self.get_box_aspect())
-                box_aspect[ax_indices] = deltas[ax_indices]
+                box_aspect = np.array(self._box_aspect)
+                box_aspect[ax_indices] = ptp[ax_indices]
                 remaining_ax_indices = {0, 1, 2}.difference(ax_indices)
                 if remaining_ax_indices:
                     remaining_ax_index = remaining_ax_indices.pop()
                     old_diag = np.linalg.norm(box_aspect[ax_indices])
-                    new_diag = np.linalg.norm(deltas[ax_indices])
+                    new_diag = np.linalg.norm(ptp[ax_indices])
                     box_aspect[remaining_ax_index] *= new_diag / old_diag
                 self.set_box_aspect(box_aspect)
 
