- Show only the most standard combination of a partial signature in the

timhoffm · timhoffm · commit 8f34d7959575 · 2021-06-15T23:55:26.000+02:00
title.
- Add a link to the docstring of the respective function.
- Minor text cleanups on the gallery page.
diff --git a/plot_types/README.rst b/plot_types/README.rst
@@ -3,8 +3,7 @@
 Plot types
 ==========
 
-This gallery lists many of the plotting commands in Matplotlib, 
-(but not all of them!).
+Overview of many common plotting commands in Matplotlib.
 
 Note that we have stripped all labels, but they are present by default.  
 See the `gallery <../gallery/index.html>`_ for many more examples and 
diff --git a/plot_types/arrays/README.rst b/plot_types/arrays/README.rst
@@ -3,4 +3,4 @@
 Plots of arrays and fields
 --------------------------
 
-Plotting for arrays of data ``Z(x, y)`` and fields ``U(x, y), V(x, y)``
+Plotting for arrays of data ``Z(x, y)`` and fields ``U(x, y), V(x, y)``.
diff --git a/plot_types/arrays/contourf.py b/plot_types/arrays/contourf.py
@@ -1,7 +1,9 @@
 """
-=====================================
-contour[f]([X, Y], Z, [levels=], ...)
-=====================================
+====================================
+contour(X, Y, Z) / contourf(X, Y, Z)
+====================================
+
+See `~matplotlib.axes.Axes.contour` / `~matplotlib.axes.Axes.contourf`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/arrays/imshow.py b/plot_types/arrays/imshow.py
@@ -1,7 +1,9 @@
 """
-=======================
-imshow(Z, [cmap=], ...)
-=======================
+=========
+imshow(Z)
+=========
+
+See `~matplotlib.axes.Axes.imshow`.
 """
 
 import matplotlib.pyplot as plt
diff --git a/plot_types/arrays/pcolormesh.py b/plot_types/arrays/pcolormesh.py
@@ -1,7 +1,7 @@
 """
-===================================
-pcolormesh([X, Y], Z, [cmap=], ...)
-===================================
+===================
+pcolormesh(X, Y, Z)
+===================
 
 `~.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/plot_types/arrays/quiver.py b/plot_types/arrays/quiver.py
@@ -1,7 +1,9 @@
 """
-=========================
-quiver([X, Y], U, V, ...)
-=========================
+==================
+quiver(X, Y, U, V)
+==================
+
+See `~matplotlib.axes.Axes.quiver`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/arrays/streamplot.py b/plot_types/arrays/streamplot.py
@@ -1,7 +1,9 @@
 """
-========================
-streamplot([X, Y], U, V)
-========================
+======================
+streamplot(X, Y, U, V)
+======================
+
+See `~matplotlib.axes.Axes.streamplot`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/basic/README.rst b/plot_types/basic/README.rst
@@ -3,4 +3,4 @@
 Basic
 -----
 
-Basic plot types, usually x versus y.  
+Basic plot types, usually y versus x.
diff --git a/plot_types/basic/bar.py b/plot_types/basic/bar.py
@@ -1,7 +1,9 @@
 """
-======================
-bar[h](x, height, ...)
-======================
+================================
+bar(x, height) / barh(x, height)
+================================
+
+See `~matplotlib.axes.Axes.bar` / `~matplotlib.axes.Axes.barh`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/basic/pie.py b/plot_types/basic/pie.py
@@ -1,7 +1,9 @@
 """
-====================
-pie(X, explode, ...)
-====================
+======
+pie(X)
+======
+
+See `~matplotlib.axes.Axes.pie`.
 """
 import matplotlib as mpl
 import matplotlib.pyplot as plt
diff --git a/plot_types/basic/plot.py b/plot_types/basic/plot.py
@@ -1,7 +1,9 @@
 """
-======================
-plot([X], Y, [fmt]...)
-======================
+==========
+plot(X, Y)
+==========
+
+See `~matplotlib.axes.Axes.plot`.
 """
 
 import matplotlib.pyplot as plt
diff --git a/plot_types/basic/scatter_plot.py b/plot_types/basic/scatter_plot.py
@@ -1,7 +1,9 @@
 """
-==================
-scatter(X, Y, ...)
-==================
+=============
+scatter(X, Y)
+=============
+
+See `~matplotlib.axes.Axes.scatter`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/basic/stem.py b/plot_types/basic/stem.py
@@ -1,7 +1,9 @@
 """
-=================
-stem([x], y, ...)
-=================
+==========
+stem(x, y)
+==========
+
+See `~matplotlib.axes.Axes.stem`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/basic/step.py b/plot_types/basic/step.py
@@ -1,7 +1,9 @@
 """
-=====================
-step(x, y, where=...)
-=====================
+==========
+step(x, y)
+==========
+
+See `~matplotlib.axes.Axes.step`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/README.rst b/plot_types/stats/README.rst
@@ -3,4 +3,4 @@
 Specialized statistics plots
 ----------------------------
 
-Matplotlib has some specialized plots for statistical analysis.  
+Specialized plots for statistical analysis.
diff --git a/plot_types/stats/barbs.py b/plot_types/stats/barbs.py
@@ -1,7 +1,9 @@
 """
-========================
-barbs([X, Y], U, V, ...)
-========================
+===========
+barbs(U, V)
+===========
+
+See `~matplotlib.axes.Axes.barbs`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/boxplot_plot.py b/plot_types/stats/boxplot_plot.py
@@ -1,7 +1,9 @@
 """
-==============
-boxplot(X,...)
-==============
+==========
+boxplot(X)
+==========
+
+See `~matplotlib.axes.Axes.boxplot`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/errorbar_plot.py b/plot_types/stats/errorbar_plot.py
@@ -1,7 +1,9 @@
 """
-==============================
-errorbar(X, Y, xerr, yerr,...)
-==============================
+==========================
+errorbar(X, Y, xerr, yerr)
+==========================
+
+See `~matplotlib.axes.Axes.errorbar`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/eventplot.py b/plot_types/stats/eventplot.py
@@ -1,7 +1,9 @@
 """
-=================
-eventplot(D, ...)
-=================
+============
+eventplot(D)
+============
+
+See `~matplotlib.axes.Axes.eventplot`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/hexbin.py b/plot_types/stats/hexbin.py
@@ -1,7 +1,9 @@
 """
-=================================
-hexbin(x, y, [C], [gridsize],...)
-=================================
+===============
+hexbin(x, y, C)
+===============
+
+See `~matplotlib.axes.Axes.hexbin`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/hist2d.py b/plot_types/stats/hist2d.py
@@ -1,7 +1,9 @@
 """
-==================================
-hist2d(x, y, [(xbins, ybins)],...)
-==================================
+============
+hist2d(x, y)
+============
+
+See `~matplotlib.axes.Axes.hist2d`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/hist_plot.py b/plot_types/stats/hist_plot.py
@@ -1,7 +1,9 @@
 """
-========================
-hist(X, [bins],...)
-========================
+=======
+hist(X)
+=======
+
+See `~matplotlib.axes.Axes.hist`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/stats/violin.py b/plot_types/stats/violin.py
@@ -1,7 +1,9 @@
 """
-=================
-violinplot(D,...)
-=================
+=============
+violinplot(D)
+=============
+
+See `~matplotlib.axes.Axes.violinplot`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/unstructured/tricontour.py b/plot_types/unstructured/tricontour.py
@@ -1,7 +1,9 @@
 """
-==============================
-tripcontour(x, y, z, [levels])
-==============================
+==========================================
+tricontour(x, y, z) / tricontourf(x, y, z)
+==========================================
+
+See `~matplotlib.axes.Axes.tricontour` / `~matplotlib.axes.Axes.tricontourf`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/unstructured/tripcolor.py b/plot_types/unstructured/tripcolor.py
@@ -2,6 +2,8 @@
 ==================
 tripcolor(x, y, z)
 ==================
+
+See `~matplotlib.axes.Axes.tripcolor`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/plot_types/unstructured/triplot.py b/plot_types/unstructured/triplot.py
@@ -1,7 +1,9 @@
 """
-=========================
-triplot(x, y, [triangle])
-=========================
+=============
+triplot(x, y)
+=============
+
+See `~matplotlib.axes.Axes.triplot`.
 """
 import matplotlib.pyplot as plt
 import numpy as np
