add docstring for set_3d_properties

ianhi · ianhi · commit aad29861111f · 2021-02-24T15:43:39.000-05:00
Also give the zdir a default argument to bring it in line with the other versions of that function.
diff --git a/lib/mpl_toolkits/mplot3d/art3d.py b/lib/mpl_toolkits/mplot3d/art3d.py
@@ -463,7 +463,18 @@ def set_sort_zpos(self, val):
         self._sort_zpos = val
         self.stale = True
 
-    def set_3d_properties(self, zs, zdir):
+    def set_3d_properties(self, zs, zdir='z'):
+        """
+        Update the z values of the offsets. If there are more XY points in
+        the offsets than there are Z points then points without a Z offset
+        will not be drawn.
+
+        Parameters
+        ----------
+        zs : array-like
+            The new z values for the offsets.
+        zdir : {'x', 'y', 'z'}, default: 'z'
+        """
         # Force the collection to initialize the face and edgecolors
         # just in case it is a scalarmappable with a colormap.
         self.update_scalarmappable()
