Use array-like in docs (#14715)

anntzer · web-flow · commit 0d6fd56370d7 · 2019-07-18T00:46:01.000+02:00
Use array-like in docs
diff --git a/examples/statistics/confidence_ellipse.py b/examples/statistics/confidence_ellipse.py
@@ -44,7 +44,7 @@ def confidence_ellipse(x, y, ax, n_std=3.0, facecolor='none', **kwargs):
 
     Parameters
     ----------
-    x, y : array_like, shape (n, )
+    x, y : array-like, shape (n, )
         Input data.
 
     ax : matplotlib.axes.Axes
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1053,11 +1053,11 @@ def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
         y : scalar or sequence of scalar
             y-indexes where to plot the lines.
 
-        xmin, xmax : scalar or 1D array_like
+        xmin, xmax : scalar or 1D array-like
             Respective beginning and end of each line. If scalars are
             provided, all lines will have same length.
 
-        colors : array_like of colors, optional, default: 'k'
+        colors : array-like of colors, optional, default: 'k'
 
         linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
 
@@ -1128,14 +1128,14 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
 
         Parameters
         ----------
-        x : scalar or 1D array_like
+        x : scalar or 1D array-like
             x-indexes where to plot the lines.
 
-        ymin, ymax : scalar or 1D array_like
+        ymin, ymax : scalar or 1D array-like
             Respective beginning and end of each line. If scalars are
             provided, all lines will have same length.
 
-        colors : array_like of colors, optional, default: 'k'
+        colors : array-like of colors, optional, default: 'k'
 
         linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
 
@@ -1803,7 +1803,7 @@ def semilogx(self, *args, **kwargs):
         basex : scalar, optional, default 10
             Base of the x logarithm.
 
-        subsx : array_like, optional
+        subsx : array-like, optional
             The location of the minor xticks. If *None*, reasonable locations
             are automatically chosen depending on the number of decades in the
             plot. See `.Axes.set_xscale` for details.
@@ -1852,7 +1852,7 @@ def semilogy(self, *args, **kwargs):
         basey : scalar, optional, default 10
             Base of the y logarithm.
 
-        subsy : array_like, optional
+        subsy : array-like, optional
             The location of the minor yticks. If *None*, reasonable locations
             are automatically chosen depending on the number of decades in the
             plot. See `.Axes.set_yscale` for details.
@@ -2061,11 +2061,11 @@ def step(self, x, y, *args, where='pre', data=None, **kwargs):
 
         Parameters
         ----------
-        x : array_like
+        x : array-like
             1-D sequence of x positions. It is assumed, but not checked, that
             it is uniformly increasing.
 
-        y : array_like
+        y : array-like
             1-D sequence of y levels.
 
         fmt : str, optional
@@ -4290,10 +4290,10 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
 
         Parameters
         ----------
-        x, y : scalar or array_like, shape (n, )
+        x, y : scalar or array-like, shape (n, )
             The data positions.
 
-        s : scalar or array_like, shape (n, ), optional
+        s : scalar or array-like, shape (n, ), optional
             The marker size in points**2.
             Default is ``rcParams['lines.markersize'] ** 2``.
 
@@ -4345,7 +4345,7 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
         alpha : scalar, optional, default: None
             The alpha blending value, between 0 (transparent) and 1 (opaque).
 
-        linewidths : scalar or array_like, optional, default: None
+        linewidths : scalar or array-like, optional, default: None
             The linewidth of the marker edges. Note: The default *edgecolors*
             is 'face'. You may want to change this as well.
             If *None*, defaults to :rc:`lines.linewidth`.
@@ -5707,10 +5707,10 @@ def pcolor(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
 
         Parameters
         ----------
-        C : array_like
+        C : array-like
             A scalar 2-D array. The values will be color-mapped.
 
-        X, Y : array_like, optional
+        X, Y : array-like, optional
             The coordinates of the quadrilateral corners. The quadrilateral
             for ``C[i, j]`` has corners at::
 
@@ -5938,10 +5938,10 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
 
         Parameters
         ----------
-        C : array_like
+        C : array-like
             A scalar 2-D array. The values will be color-mapped.
 
-        X, Y : array_like, optional
+        X, Y : array-like, optional
             The coordinates of the quadrilateral corners. The quadrilateral
             for ``C[i, j]`` has corners at::
 
@@ -6405,7 +6405,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
 
             Default is ``False``.
 
-        weights : (n, ) array_like or None, optional
+        weights : (n, ) array-like or None, optional
             An array of weights, of the same shape as *x*.  Each value in *x*
             only contributes its associated weight towards the bin count
             (instead of 1).  If *normed* or *density* is ``True``,
@@ -6438,7 +6438,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
 
             Default is ``False``
 
-        bottom : array_like, scalar, or None
+        bottom : array-like, scalar, or None
             Location of the bottom baseline of each bin.  If a scalar,
             the base line for each bin is shifted by the same amount.
             If an array, each bin is shifted independently and the length
@@ -6487,7 +6487,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
 
             Default is ``False``
 
-        color : color or array_like of colors or None, optional
+        color : color or array-like of colors or None, optional
             Color or sequence of colors, one per dataset.  Default (``None``)
             uses the standard line color sequence.
 
@@ -6850,25 +6850,25 @@ def hist2d(self, x, y, bins=10, range=None, density=False, weights=None,
 
         Parameters
         ----------
-        x, y : array_like, shape (n, )
+        x, y : array-like, shape (n, )
             Input values
 
-        bins : None or int or [int, int] or array_like or [array, array]
+        bins : None or int or [int, int] or array-like or [array, array]
 
             The bin specification:
 
             - If int, the number of bins for the two dimensions
               (nx=ny=bins).
             - If ``[int, int]``, the number of bins in each dimension
               (nx, ny = bins).
-            - If array_like, the bin edges for the two dimensions
+            - If array-like, the bin edges for the two dimensions
               (x_edges=y_edges=bins).
             - If ``[array, array]``, the bin edges in each dimension
               (x_edges, y_edges = bins).
 
             The default value is 10.
 
-        range : array_like shape(2, 2), optional, default: None
+        range : array-like shape(2, 2), optional, default: None
             The leftmost and rightmost edges of the bins along each dimension
             (if not specified explicitly in the bins parameters): ``[[xmin,
             xmax], [ymin, ymax]]``. All values outside of this range will be
@@ -6878,7 +6878,7 @@ def hist2d(self, x, y, bins=10, range=None, density=False, weights=None,
             Normalize histogram.  *normed* is a deprecated synonym for this
             parameter.
 
-        weights : array_like, shape (n, ), optional, default: None
+        weights : array-like, shape (n, ), optional, default: None
             An array of values w_i weighing each sample (x_i, y_i).
 
         cmin : scalar, optional, default: None
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -269,10 +269,10 @@ def draw_gouraud_triangle(self, gc, points, colors, transform):
 
         Parameters
         ----------
-        points : array_like, shape=(3, 2)
+        points : array-like, shape=(3, 2)
             Array of (x, y) points for the triangle.
 
-        colors : array_like, shape=(3, 4)
+        colors : array-like, shape=(3, 4)
             RGBA colors for each point of the triangle.
 
         transform : `matplotlib.transforms.Transform`
@@ -288,10 +288,10 @@ def draw_gouraud_triangles(self, gc, triangles_array, colors_array,
 
         Parameters
         ----------
-        points : array_like, shape=(N, 3, 2)
+        points : array-like, shape=(N, 3, 2)
             Array of *N* (x, y) points for the triangles.
 
-        colors : array_like, shape=(N, 3, 4)
+        colors : array-like, shape=(N, 3, 4)
             Array of *N* RGBA colors for each point of the triangles.
 
         transform : `matplotlib.transforms.Transform`
@@ -471,7 +471,7 @@ def draw_image(self, gc, x, y, im, transform=None):
             the distance in physical units (i.e., dots or pixels) from the
             bottom side of the canvas.
 
-        im : array_like, shape=(N, M, 4), dtype=np.uint8
+        im : array-like, shape=(N, M, 4), dtype=np.uint8
             An array of RGBA pixels.
 
         transform : `matplotlib.transforms.Affine2DBase`
@@ -668,7 +668,7 @@ def points_to_pixels(self, points):
 
         Parameters
         ----------
-        points : scalar or array_like
+        points : scalar or array-like
             a float or a numpy array of float
 
         Returns
@@ -899,7 +899,7 @@ def set_dashes(self, dash_offset, dash_list):
         ----------
         dash_offset : float or None
             The offset (usually 0).
-        dash_list : array_like or None
+        dash_list : array-like or None
             The on-off sequence as points.
 
         Notes
diff --git a/lib/matplotlib/markers.py b/lib/matplotlib/markers.py
@@ -231,7 +231,7 @@ def __init__(self, marker=None, fillstyle=None):
 
         Parameters
         ----------
-        marker : string or array_like, optional, default: None
+        marker : string or array-like, optional, default: None
             See the descriptions of possible markers in the module docstring.
 
         fillstyle : string, optional, default: 'full'
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -981,7 +981,7 @@ def specgram(x, NFFT=None, Fs=None, detrend=None, window=None,
 
     Parameters
     ----------
-    x : array_like
+    x : array-like
         1-D array or sequence.
 
     %(Spectral)s
@@ -1010,13 +1010,13 @@ def specgram(x, NFFT=None, Fs=None, detrend=None, window=None,
 
     Returns
     -------
-    spectrum : array_like
+    spectrum : array-like
         2-D array, columns are the periodograms of successive segments.
 
-    freqs : array_like
+    freqs : array-like
         1-D array, frequencies corresponding to the rows in *spectrum*.
 
-    t : array_like
+    t : array-like
         1-D array, the times corresponding to midpoints of segments
         (i.e the columns in *spectrum*).
 
@@ -1392,7 +1392,7 @@ class GaussianKDE:
 
     Parameters
     ----------
-    dataset : array_like
+    dataset : array-like
         Datapoints to estimate from. In case of univariate data this is a 1-D
         array, otherwise a 2-D array with shape (# of dims, # of data).
 
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -100,15 +100,15 @@ def __init__(self, vertices, codes=None, _interpolation_steps=1,
 
         Parameters
         ----------
-        vertices : array_like
-            The ``(n, 2)`` float array, masked array or sequence of pairs
+        vertices : array-like
+            The ``(N, 2)`` float array, masked array or sequence of pairs
             representing the vertices of the path.
 
             If *vertices* contains masked values, they will be converted
             to NaNs which are then handled correctly by the Agg
             PathIterator and other consumers of path data, such as
             :meth:`iter_segments`.
-        codes : {None, array_like}, optional
+        codes : array-like or None, optional
             n-length array integers representing the codes of the path.
             If not None, codes must be the same length as vertices.
             If None, *vertices* will be treated as a series of line segments.
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1443,11 +1443,11 @@ def xticks(ticks=None, labels=None, **kwargs):
 
     Parameters
     ----------
-    ticks : array_like
+    ticks : array-like
         A list of positions at which ticks should be placed. You can pass an
         empty list to disable xticks.
 
-    labels : array_like, optional
+    labels : array-like, optional
         A list of explicit labels to place at the given *locs*.
 
     **kwargs
@@ -1518,11 +1518,11 @@ def yticks(ticks=None, labels=None, **kwargs):
 
     Parameters
     ----------
-    ticks : array_like
+    ticks : array-like
         A list of positions at which ticks should be placed. You can pass an
         empty list to disable yticks.
 
-    labels : array_like, optional
+    labels : array-like, optional
         A list of explicit labels to place at the given *locs*.
 
     **kwargs
diff --git a/lib/matplotlib/tests/test_triangulation.py b/lib/matplotlib/tests/test_triangulation.py
@@ -1101,7 +1101,7 @@ def test_internal_cpp_api():
 
     with pytest.raises(ValueError) as excinfo:
         trifinder.find_many([0], [0, 1])
-    excinfo.match(r'x and y must be array_like with same shape')
+    excinfo.match(r'x and y must be array-like with same shape')
 
 
 def test_qhull_large_offset():
diff --git a/lib/matplotlib/tri/triangulation.py b/lib/matplotlib/tri/triangulation.py
@@ -11,7 +11,7 @@ class Triangulation:
     ----------
     x, y : array-like of shape (npoints)
         Coordinates of grid points.
-    triangles : integer array_like of shape (ntri, 3), optional
+    triangles : integer array-like of shape (ntri, 3), optional
         For each triangle, the indices of the three points that make
         up the triangle, ordered in an anticlockwise manner.  If not
         specified, the Delaunay triangulation is calculated.
diff --git a/lib/matplotlib/tri/trifinder.py b/lib/matplotlib/tri/trifinder.py
@@ -13,7 +13,7 @@ class TriFinder:
     usually better to use the function
     :func:`matplotlib.tri.Triangulation.get_trifinder`.
 
-    Derived classes implement __call__(x, y) where x and y are array_like point
+    Derived classes implement __call__(x, y) where x and y are array-like point
     coordinates of the same shape.
     """
     def __init__(self, triangulation):
@@ -46,7 +46,7 @@ def __call__(self, x, y):
         specified *x*, *y* points lie, or -1 for points that do not lie within
         a triangle.
 
-        *x*, *y* are array_like x and y coordinates of the same shape and any
+        *x*, *y* are array-like x and y coordinates of the same shape and any
         number of dimensions.
 
         Returns integer array with the same shape and *x* and *y*.
diff --git a/lib/matplotlib/tri/triinterpolate.py b/lib/matplotlib/tri/triinterpolate.py
diff --git a/lib/mpl_toolkits/mplot3d/art3d.py b/lib/mpl_toolkits/mplot3d/art3d.py
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
diff --git a/src/tri/_tri_wrapper.cpp b/src/tri/_tri_wrapper.cpp
