Merge pull request #22652 from oscargus/seealso

QuLogic · web-flow · commit 9d67b021920c · 2022-03-16T17:01:21.000-04:00
Update documentation example and fix See also
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -368,7 +368,7 @@ An example docstring looks like:
 
 .. code-block:: python
 
-    def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
+    def hlines(self, y, xmin, xmax, colors=None, linestyles='solid',
                label='', **kwargs):
         """
         Plot horizontal lines at each *y* from *xmin* to *xmax*.
@@ -382,24 +382,26 @@ An example docstring looks like:
             Respective beginning and end of each line. If scalars are
             provided, all lines will have the same length.
 
-        colors : array-like of colors, default: 'k'
+        colors : list of colors, default: :rc:`lines.color`
 
-        linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, default: 'solid'
+        linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
 
         label : str, default: ''
 
         Returns
         -------
-        lines : `~matplotlib.collections.LineCollection`
+        `~matplotlib.collections.LineCollection`
 
         Other Parameters
         ----------------
-        **kwargs : `~matplotlib.collections.LineCollection` properties
+        data : indexable object, optional
+            DATA_PARAMETER_PLACEHOLDER
+        **kwargs :  `~matplotlib.collections.LineCollection` properties.
 
-        See also
+        See Also
         --------
         vlines : vertical lines
-        axhline: horizontal line across the axes
+        axhline : horizontal line across the Axes
         """
 
 See the `~.Axes.hlines` documentation for how this renders.
@@ -566,10 +568,10 @@ effect.
 Sphinx automatically links code elements in the definition blocks of ``See
 also`` sections. No need to use backticks there::
 
-   See also
+   See Also
    --------
    vlines : vertical lines
-   axhline: horizontal line across the axes
+   axhline : horizontal line across the Axes
 
 Wrapping parameter lists
 ~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1013,7 +1013,7 @@ def hlines(self, y, xmin, xmax, colors=None, linestyles='solid',
 
         xmin, xmax : float or array-like
             Respective beginning and end of each line. If scalars are
-            provided, all lines will have same length.
+            provided, all lines will have the same length.
 
         colors : list of colors, default: :rc:`lines.color`
 
@@ -1092,7 +1092,7 @@ def vlines(self, x, ymin, ymax, colors=None, linestyles='solid',
 
         ymin, ymax : float or array-like
             Respective beginning and end of each line. If scalars are
-            provided, all lines will have same length.
+            provided, all lines will have the same length.
 
         colors : list of colors, default: :rc:`lines.color`
 
