Merge pull request matplotlib#27929 from timhoffm/doc-plot-types

QuLogic · web-flow · commit e20ce219f899 · 2024-03-20T03:51:13.000-04:00
DOC: Add summary lines to plot types
diff --git a/galleries/plot_types/arrays/barbs.py b/galleries/plot_types/arrays/barbs.py
@@ -2,6 +2,7 @@
 =================
 barbs(X, Y, U, V)
 =================
+Plot a 2D field of wind barbs.
 
 See `~matplotlib.axes.Axes.barbs`.
 """
diff --git a/galleries/plot_types/arrays/contour.py b/galleries/plot_types/arrays/contour.py
@@ -2,6 +2,7 @@
 ================
 contour(X, Y, Z)
 ================
+Plot contour lines.
 
 See `~matplotlib.axes.Axes.contour`.
 """
diff --git a/galleries/plot_types/arrays/contourf.py b/galleries/plot_types/arrays/contourf.py
@@ -2,6 +2,7 @@
 =================
 contourf(X, Y, Z)
 =================
+Plot filled contours.
 
 See `~matplotlib.axes.Axes.contourf`.
 """
diff --git a/galleries/plot_types/arrays/imshow.py b/galleries/plot_types/arrays/imshow.py
@@ -2,6 +2,7 @@
 =========
 imshow(Z)
 =========
+Display data as an image, i.e., on a 2D regular raster.
 
 See `~matplotlib.axes.Axes.imshow`.
 """
diff --git a/galleries/plot_types/arrays/pcolormesh.py b/galleries/plot_types/arrays/pcolormesh.py
@@ -2,6 +2,7 @@
 ===================
 pcolormesh(X, Y, Z)
 ===================
+Create a pseudocolor plot with a non-regular rectangular grid.
 
 `~.axes.Axes.pcolormesh` is more flexible than `~.axes.Axes.imshow` in that
 the x and y vectors need not be equally spaced (indeed they can be skewed).
diff --git a/galleries/plot_types/arrays/quiver.py b/galleries/plot_types/arrays/quiver.py
@@ -2,6 +2,7 @@
 ==================
 quiver(X, Y, U, V)
 ==================
+Plot a 2D field of arrows.
 
 See `~matplotlib.axes.Axes.quiver`.
 """
diff --git a/galleries/plot_types/arrays/streamplot.py b/galleries/plot_types/arrays/streamplot.py
@@ -2,6 +2,7 @@
 ======================
 streamplot(X, Y, U, V)
 ======================
+Draw streamlines of a vector flow.
 
 See `~matplotlib.axes.Axes.streamplot`.
 """
diff --git a/galleries/plot_types/basic/fill_between.py b/galleries/plot_types/basic/fill_between.py
@@ -2,6 +2,7 @@
 =======================
 fill_between(x, y1, y2)
 =======================
+Fill the area between two horizontal curves.
 
 See `~matplotlib.axes.Axes.fill_between`.
 """
diff --git a/galleries/plot_types/basic/plot.py b/galleries/plot_types/basic/plot.py
@@ -2,6 +2,7 @@
 ==========
 plot(x, y)
 ==========
+Plot y versus x as lines and/or markers.
 
 See `~matplotlib.axes.Axes.plot`.
 """
diff --git a/galleries/plot_types/basic/scatter_plot.py b/galleries/plot_types/basic/scatter_plot.py
@@ -2,6 +2,7 @@
 =============
 scatter(x, y)
 =============
+A scatter plot of y vs. x with varying marker size and/or color.
 
 See `~matplotlib.axes.Axes.scatter`.
 """
diff --git a/galleries/plot_types/basic/stackplot.py b/galleries/plot_types/basic/stackplot.py
@@ -2,6 +2,8 @@
 ===============
 stackplot(x, y)
 ===============
+Draw a stacked area plot or a streamgraph.
+
 See `~matplotlib.axes.Axes.stackplot`
 """
 import matplotlib.pyplot as plt
diff --git a/galleries/plot_types/basic/stairs.py b/galleries/plot_types/basic/stairs.py
@@ -2,6 +2,7 @@
 ==============
 stairs(values)
 ==============
+Draw a stepwise constant function as a line or a filled plot.
 
 See `~matplotlib.axes.Axes.stairs` when plotting :math:`y` between
 :math:`(x_i, x_{i+1})`. For plotting :math:`y` at :math:`x`, see
diff --git a/galleries/plot_types/basic/stem.py b/galleries/plot_types/basic/stem.py
@@ -2,6 +2,7 @@
 ==========
 stem(x, y)
 ==========
+Create a stem plot.
 
 See `~matplotlib.axes.Axes.stem`.
 """
diff --git a/galleries/plot_types/stats/boxplot_plot.py b/galleries/plot_types/stats/boxplot_plot.py
@@ -2,6 +2,7 @@
 ==========
 boxplot(X)
 ==========
+Draw a box and whisker plot.
 
 See `~matplotlib.axes.Axes.boxplot`.
 """
diff --git a/galleries/plot_types/stats/ecdf.py b/galleries/plot_types/stats/ecdf.py
@@ -2,6 +2,7 @@
 =======
 ecdf(x)
 =======
+Compute and plot the empirical cumulative distribution function of x.
 
 See `~matplotlib.axes.Axes.ecdf`.
 """
diff --git a/galleries/plot_types/stats/errorbar_plot.py b/galleries/plot_types/stats/errorbar_plot.py
@@ -2,6 +2,7 @@
 ==========================
 errorbar(x, y, yerr, xerr)
 ==========================
+Plot y versus x as lines and/or markers with attached errorbars.
 
 See `~matplotlib.axes.Axes.errorbar`.
 """
diff --git a/galleries/plot_types/stats/eventplot.py b/galleries/plot_types/stats/eventplot.py
@@ -2,6 +2,7 @@
 ============
 eventplot(D)
 ============
+Plot identical parallel lines at the given positions.
 
 See `~matplotlib.axes.Axes.eventplot`.
 """
diff --git a/galleries/plot_types/stats/hexbin.py b/galleries/plot_types/stats/hexbin.py
@@ -2,6 +2,7 @@
 ===============
 hexbin(x, y, C)
 ===============
+Make a 2D hexagonal binning plot of points x, y.
 
 See `~matplotlib.axes.Axes.hexbin`.
 """
diff --git a/galleries/plot_types/stats/hist2d.py b/galleries/plot_types/stats/hist2d.py
@@ -2,6 +2,7 @@
 ============
 hist2d(x, y)
 ============
+Make a 2D histogram plot.
 
 See `~matplotlib.axes.Axes.hist2d`.
 """
diff --git a/galleries/plot_types/stats/hist_plot.py b/galleries/plot_types/stats/hist_plot.py
@@ -2,6 +2,7 @@
 =======
 hist(x)
 =======
+Compute and plot a histogram.
 
 See `~matplotlib.axes.Axes.hist`.
 """
diff --git a/galleries/plot_types/stats/pie.py b/galleries/plot_types/stats/pie.py
@@ -2,6 +2,7 @@
 ======
 pie(x)
 ======
+Plot a pie chart.
 
 See `~matplotlib.axes.Axes.pie`.
 """
diff --git a/galleries/plot_types/stats/violin.py b/galleries/plot_types/stats/violin.py
@@ -2,6 +2,7 @@
 =============
 violinplot(D)
 =============
+Make a violin plot.
 
 See `~matplotlib.axes.Axes.violinplot`.
 """
diff --git a/galleries/plot_types/unstructured/tricontour.py b/galleries/plot_types/unstructured/tricontour.py
@@ -2,6 +2,7 @@
 ===================
 tricontour(x, y, z)
 ===================
+Draw contour lines on an unstructured triangular grid.
 
 See `~matplotlib.axes.Axes.tricontour`.
 """
diff --git a/galleries/plot_types/unstructured/tricontourf.py b/galleries/plot_types/unstructured/tricontourf.py
@@ -2,6 +2,7 @@
 ====================
 tricontourf(x, y, z)
 ====================
+Draw contour regions on an unstructured triangular grid.
 
 See `~matplotlib.axes.Axes.tricontourf`.
 """
diff --git a/galleries/plot_types/unstructured/tripcolor.py b/galleries/plot_types/unstructured/tripcolor.py
@@ -2,6 +2,7 @@
 ==================
 tripcolor(x, y, z)
 ==================
+Create a pseudocolor plot of an unstructured triangular grid.
 
 See `~matplotlib.axes.Axes.tripcolor`.
 """
diff --git a/galleries/plot_types/unstructured/triplot.py b/galleries/plot_types/unstructured/triplot.py
@@ -2,6 +2,7 @@
 =============
 triplot(x, y)
 =============
+Draw an unstructured triangular grid as lines and/or markers.
 
 See `~matplotlib.axes.Axes.triplot`.
 """
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -7104,16 +7104,19 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
     def stairs(self, values, edges=None, *,
                orientation='vertical', baseline=0, fill=False, **kwargs):
         """
-        A stepwise constant function as a line with bounding edges
-        or a filled plot.
+        Draw a stepwise constant function as a line or a filled plot.
+
+        *edges* define the x-axis positions of the steps. *values* the function values
+        between these steps. Depending on *fill*, the function is drawn either as a
+        continuous line with vertical segments at the edges, or as a filled area.
 
         Parameters
         ----------
         values : array-like
             The step heights.
 
         edges : array-like
-            The edge positions, with ``len(edges) == len(vals) + 1``,
+            The step positions, with ``len(edges) == len(vals) + 1``,
             between which the curve takes on vals values.
 
         orientation : {'vertical', 'horizontal'}, default: 'vertical'
diff --git a/lib/matplotlib/quiver.py b/lib/matplotlib/quiver.py
@@ -727,7 +727,7 @@ def _h_arrows(self, length):
 
 
 _barbs_doc = r"""
-Plot a 2D field of barbs.
+Plot a 2D field of wind barbs.
 
 Call signature::
 
diff --git a/lib/matplotlib/stackplot.py b/lib/matplotlib/stackplot.py
@@ -19,7 +19,7 @@ def stackplot(axes, x, *args,
               labels=(), colors=None, hatch=None, baseline='zero',
               **kwargs):
     """
-    Draw a stacked area plot.
+    Draw a stacked area plot or a streamgraph.
 
     Parameters
     ----------
