improve docstrings of pyplot.xlabel and pyplot.ylabel

timhoffm · timhoffm · commit 8ebca4a3a350 · 2018-02-01T22:32:58.000+01:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -210,19 +210,20 @@ def get_xlabel(self):
 
     def set_xlabel(self, xlabel, fontdict=None, labelpad=None, **kwargs):
         """
-        Set the label for the xaxis.
+        Set the label for the x-axis.
 
         Parameters
         ----------
-        xlabel : string
-            x label
+        xlabel : str
+            The label text.
 
         labelpad : scalar, optional, default: None
-            spacing in points between the label and the x-axis
+            Spacing in points between the label and the x-axis.
 
         Other Parameters
         ----------------
-        **kwargs : `~matplotlib.text.Text` properties
+        **kwargs : `.Text` properties
+            `.Text` properties control the appearance of the label.
 
         See also
         --------
@@ -241,19 +242,20 @@ def get_ylabel(self):
 
     def set_ylabel(self, ylabel, fontdict=None, labelpad=None, **kwargs):
         """
-        Set the label for the yaxis
+        Set the label for the y-axis.
 
         Parameters
         ----------
-        ylabel : string
-            y label
+        ylabel : str
+            The label text.
 
         labelpad : scalar, optional, default: None
-            spacing in points between the label and the y-axis
+            Spacing in points between the label and the y-axis.
 
         Other Parameters
         ----------------
-        **kwargs : `~matplotlib.text.Text` properties
+        **kwargs : `.Text` properties
+            `.Text` properties control the appearance of the label.
 
         See also
         --------
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1500,41 +1500,28 @@ def axis(*v, **kwargs):
 
 def xlabel(s, *args, **kwargs):
     """
-    Set the *x* axis label of the current axis.
+    Set the x-axis label of the current axes.
 
-    Default override is::
-
-      override = {
-          'fontsize'            : 'small',
-          'verticalalignment'   : 'top',
-          'horizontalalignment' : 'center'
-          }
+    Call signature::
 
-    .. seealso::
+        xlabel(label, fontdict=None, labelpad=None, **kwargs)
 
-        :func:`~matplotlib.pyplot.text`
-            For information on how override and the optional args work
+    This is just a shortcut for calling `.set_xlabel` on the current axes.
+    See there for a full parameter description.
     """
     return gca().set_xlabel(s, *args, **kwargs)
 
 
 def ylabel(s, *args, **kwargs):
     """
-    Set the *y* axis label of the current axis.
+    Set the y-axis label of the current axes.
 
-    Defaults override is::
-
-        override = {
-           'fontsize'            : 'small',
-           'verticalalignment'   : 'center',
-           'horizontalalignment' : 'right',
-           'rotation'='vertical' : }
+    Call signature::
 
-    .. seealso::
+        ylabel(label, fontdict=None, labelpad=None, **kwargs)
 
-        :func:`~matplotlib.pyplot.text`
-            For information on how override and the optional args
-            work.
+    This is just a shortcut for calling `.set_ylabel` on the current axes.
+    See there for a full parameter description.
     """
     return gca().set_ylabel(s, *args, **kwargs)
 
@@ -1565,7 +1552,7 @@ def xlim(*args, **kwargs):
     Notes
     -----
     This is just a shortcut for calling `~.Axes.get_xlim` or `~.Axes.set_xlim`
-    on the current axes. All parameters are passed to the latter.
+    on the current axes.
     """
     ax = gca()
     if not args and not kwargs:
@@ -1600,7 +1587,7 @@ def ylim(*args, **kwargs):
     Notes
     -----
     This is just a shortcut for calling `~.Axes.get_ylim` or `~.Axes.set_ylim`
-    on the current axes. All parameters are passed to the latter.
+    on the current axes.
     """
     ax = gca()
     if not args and not kwargs:
@@ -1679,7 +1666,7 @@ def xticks(*args, **kwargs):
     -----
     This is just a convenient shortcut for calling `.get_xticks` and
     `.get_xticklabels` or `.set_xticks` and `.set_xticklabels` on the current
-    axes.
+    axes. All parameters are passed to the latter.
 
     Examples
     --------
@@ -1755,7 +1742,7 @@ def yticks(*args, **kwargs):
     -----
     This is just a convenient shortcut for calling `.get_yticks` and
     `.get_yticklabels` or `.set_yticks` and `.set_yticklabels` on the current
-    axes.
+    axes.  All parameters are passed to the latter.
 
     Examples
     --------
