Update docstring of QuadMesh

timhoffm · timhoffm · commit c811d1ce6782 · 2021-05-24T00:53:35.000+02:00
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1968,6 +1968,34 @@ class QuadMesh(Collection):
     """
     Class for the efficient drawing of a quadrilateral mesh.
 
+    A quadrilateral mesh consists of a (N, M) grid of vertices, that define
+    N-1 * M-1 quadrilaterals ::
+
+      :         (m+1, n) ----------- (m+1, n+1)
+      :            /                   /
+      :           /                 /
+      :          /               /
+      :      (m, n) -------- (m, n+1)
+
+    The mesh need not be regular and the polygons need not be convex.
+
+    Parameters
+    ----------
+    coordimates : (M, N, 2) array-like
+        The vertices. ``coordinates[m, n]`` specified the coordinates (x, y)
+        of vertex (m, n).
+
+    antialiased : bool, default: True
+
+    shading : {'flat', 'gouraud'}, default: 'flat'
+
+    Notes
+    -----
+    There exists a deprecated API version ``QuadMesh(M, N, coords)``, where
+    the dimensions are given explicitly and ``coords`` is a (M*N, 2)
+    array-like. This has been deprecated in Matplotlib 3.5. The following
+    describes the semantics of this deprecated API.
+
     A quadrilateral mesh consists of a grid of vertices.
     The dimensions of this array are (*meshWidth* + 1, *meshHeight* + 1).
     Each vertex in the mesh has a different set of "mesh coordinates"
@@ -1991,7 +2019,6 @@ class QuadMesh(Collection):
     vertex at mesh coordinates (0, 0), then the one at (0, 1), then at (0, 2)
     .. (0, meshWidth), (1, 0), (1, 1), and so on.
 
-    *shading* may be 'flat', or 'gouraud'
     """
     def __init__(self, *args, **kwargs):
         # signature deprecation since="3.5": Change to new signature after the
