Update docs. And adding missing methods.

lkjell · lkjell · commit 249242f035a8 · 2018-03-09T11:48:24.000+01:00
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4227,13 +4227,15 @@ def get_shared_x_axes(self):
         return self._shared_x_axes
 
     def get_shared_x_inv_axes(self):
+        """Return a copy of inverse shared axes Weakset object for x"""
         return self._shared_x_inv_axes
 
     def get_shared_y_axes(self):
         """Return a copy of the shared axes Weakset object for y axes"""
         return self._shared_y_axes
 
     def get_shared_y_inv_axes(self):
+        """Return a copy of inverse shared axes Weakset object for y"""
         return self._shared_y_inv_axes
 
     def is_sharing_x_axes(self):
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -2940,14 +2940,24 @@ def permutation_matrices(n):
 
         return polygons
 
+    def get_shared_z_axes(self):
+        """Return a copy of the shared axes Weakset object for z axes"""
+        return self._shared_z_axes
+
+    def get_shared_z_inv_axes(self):
+        """Return a copy of inverse shared axes Weakset object for z"""
+        return self._shared_z_inv_axes
+
     def unshare_z_axes(self, axes=None):
         """
         Unshare z axis.
 
         Parameters
         ----------
         axes: Axes
-            Axes to unshare, if related. None will unshare itself.
+            Axes to unshare, if related.
+            None will unshare itself from all shares.
+            `self` will inverse unshare.
         """
         self._unshare_axes(axes, "z")
 
@@ -2958,35 +2968,45 @@ def unshare_axes(self, axes=None):
         Parameters
         ----------
         axes: Axes
-            Axes to unshare, if related. None will unshare itself.
+            Axes to unshare, if related.
+            None will unshare itself from all shares.
+            `self` will inverse unshare.
         """
         self.unshare_x_axes(axes)
         self.unshare_y_axes(axes)
         self.unshare_z_axes(axes)
 
-    def share_z_axes(self, axes):
+    def share_z_axes(self, axes, symmetric=True, transitive=True):
         """
         Share z axis.
 
         Parameters
         ----------
         axes: Axes
             Axes to share.
+        symmetric: Bool
+            mutually share.
+        transitive: Bool
+            extent share to what axes shares.
         """
-        self._share_axes(axes, 'z')
+        self._share_axes(axes, 'z', symmetric, transitive)
 
-    def share_axes(self, axes):
+    def share_axes(self, axes, symmetric=True, transitive=True):
         """
         Share x, y, z axes.
 
         Parameters
         ----------
         axes: Axes
             Axes to share.
-        """
-        self.share_x_axes(axes)
-        self.share_y_axes(axes)
-        self.share_z_axes(axes)
+        symmetric: Bool
+            mutually share.
+        transitive: Bool
+            extent share to what axes shares.
+        """
+        self.share_x_axes(axes, symmetric, transitive)
+        self.share_y_axes(axes, symmetric, transitive)
+        self.share_z_axes(axes, symmetric, transitive)
 
 
 def get_test_data(delta=0.05):
