Skip to content

Commit e6eaf13

Browse files
committed
Update docs.
1 parent 87fee27 commit e6eaf13

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
Share and unshare `axes` after creation
22
---------------------------------------
33

4-
`~.Axes` have `~.Axes.unshare_x_axes`, `~.Axes.unshare_y_axes`, `~.Axes.unshare_z_axes` and `~.Axes.unshare_axes` methods to unshare axes.
5-
Similiar there are `~.Axes.share_x_axes`, `~.Axes.share_y_axes`, `~.Axes.share_z_axes` and `~.Axes.share_axes` methods to share axes.
4+
`~.Axes` have `~.Axes.unshare_x_axes`, `~.Axes.unshare_y_axes`,
5+
`~.Axes.unshare_z_axes` and `~.Axes.unshare_axes` methods to unshare axes.
6+
Similiar there are `~.Axes.share_x_axes`, `~.Axes.share_y_axes`,
7+
`~.Axes.share_z_axes` and `~.Axes.share_axes` methods to share axes.
68

79
Unshare an axis will decouple the viewlimits for further changes.
810
Share an axis will couple the viewlimits.

lib/matplotlib/axes/_base.py

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4294,7 +4294,9 @@ def unshare_x_axes(self, axes=None):
42944294
Parameters
42954295
----------
42964296
axes: Axes
4297-
Axes to unshare, if related. None will unshare itself.
4297+
Axes to unshare, if related.
4298+
None will unshare itself from all shares.
4299+
`self` will inverse unshare.
42984300
"""
42994301
self._unshare_axes(axes, "x")
43004302

@@ -4305,7 +4307,9 @@ def unshare_y_axes(self, axes=None):
43054307
Parameters
43064308
----------
43074309
axes: Axes
4308-
Axes to unshare, if related. None will unshare itself.
4310+
Axes to unshare, if related.
4311+
None will unshare itself.
4312+
`self` will inverse unshare.
43094313
"""
43104314
self._unshare_axes(axes, "y")
43114315

@@ -4316,7 +4320,9 @@ def unshare_axes(self, axes=None):
43164320
Parameters
43174321
----------
43184322
axes: Axes
4319-
Axes to unshare, if related. None will unshare itself.
4323+
Axes to unshare, if related.
4324+
None will unshare itself.
4325+
`self` will inverse unshare.
43204326
"""
43214327
self.unshare_x_axes(axes)
43224328
self.unshare_y_axes(axes)
@@ -4373,6 +4379,10 @@ def share_x_axes(self, axes, symmetric=True, transitive=True):
43734379
----------
43744380
axes: Axes
43754381
Axes to share.
4382+
symmetric: Bool
4383+
mutually share.
4384+
transitive: Bool
4385+
extent share to what axes shares.
43764386
"""
43774387
self._share_axes(axes, 'x', symmetric, transitive)
43784388

@@ -4384,6 +4394,10 @@ def share_y_axes(self, axes, symmetric=True, transitive=True):
43844394
----------
43854395
axes: Axes
43864396
Axes to share.
4397+
symmetric: Bool
4398+
mutually share.
4399+
transitive: Bool
4400+
extent share to what axes shares.
43874401
"""
43884402
self._share_axes(axes, 'y', symmetric, transitive)
43894403

@@ -4395,6 +4409,10 @@ def share_axes(self, axes, symmetric=True, transitive=True):
43954409
----------
43964410
axes: Axes
43974411
Axes to share.
4412+
symmetric: Bool
4413+
mutually share.
4414+
transitive: Bool
4415+
extent share to what axes shares.
43984416
"""
43994417
self.share_x_axes(axes, symmetric, transitive)
44004418
self.share_y_axes(axes, symmetric, transitive)

0 commit comments

Comments
 (0)