Merge pull request #16324 from meeseeksmachine/auto-backport-of-pr-16323-on-v3.2.x

timhoffm · web-flow · commit 68e9dc5dc2aa · 2020-01-26T11:04:28.000+01:00
Backport PR #16323 on branch v3.2.x (Add sphinx doc for Axis.axis_name.)
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1914,7 +1914,7 @@ def setter(self, vmin, vmax, ignore=False):
 
 class XAxis(Axis):
     __name__ = 'xaxis'
-    axis_name = 'x'
+    axis_name = 'x'  #: Read-only name identifying the axis.
 
     def contains(self, mouseevent):
         """Test whether the mouse event occurred in the x axis.
@@ -2199,7 +2199,7 @@ def get_tick_space(self):
 
 class YAxis(Axis):
     __name__ = 'yaxis'
-    axis_name = 'y'
+    axis_name = 'y'  #: Read-only name identifying the axis.
 
     def contains(self, mouseevent):
         """Test whether the mouse event occurred in the y axis.
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -352,7 +352,7 @@ class ThetaAxis(maxis.XAxis):
     for an angular axis.
     """
     __name__ = 'thetaaxis'
-    axis_name = 'theta'
+    axis_name = 'theta'  #: Read-only name identifying the axis.
 
     def _get_tick(self, major):
         if major:
@@ -665,7 +665,7 @@ class RadialAxis(maxis.YAxis):
     for a radial axis.
     """
     __name__ = 'radialaxis'
-    axis_name = 'radius'
+    axis_name = 'radius'  #: Read-only name identifying the axis.
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
