DOC: add docstring for set_array; improve related docstrings in _axes.py

efiring · efiring · commit f1b6135b12b6 · 2016-08-24T07:49:41.000-10:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -5522,8 +5522,9 @@ def pcolormesh(self, *args, **kwargs):
         .. seealso::
 
             :func:`~matplotlib.pyplot.pcolor`
-                For an explanation of the grid orientation and the
-                expansion of 1-D *X* and/or *Y* to 2-D arrays.
+                For an explanation of the grid orientation
+                (:ref:`Grid Orientation <axes-pcolor-grid-orientation>`)
+                and the expansion of 1-D *X* and/or *Y* to 2-D arrays.
         """
         if not self._hold:
             self.cla()
@@ -5637,10 +5638,10 @@ def pcolorfast(self, *args, **kwargs):
         (*nr*-1, *nc*-1).  All cells are rectangles of the same size.
         This is the fastest version.
 
-        *x*, *y* are 1D arrays of length *nc* +1 and *nr* +1, respectively,
-        giving the x and y boundaries of the cells.  Hence the cells are
-        rectangular but the grid may be nonuniform.  The speed is
-        intermediate.  (The grid is checked, and if found to be
+        *x*, *y* are monotonic 1D arrays of length *nc* +1 and *nr* +1,
+        respectively, giving the x and y boundaries of the cells.  Hence
+        the cells are rectangular but the grid may be nonuniform.  The
+        speed is intermediate.  (The grid is checked, and if found to be
         uniform the fast version is used.)
 
         *X* and *Y* are 2D arrays with shape (*nr* +1, *nc* +1) that specify
@@ -5654,7 +5655,7 @@ def pcolorfast(self, *args, **kwargs):
 
         Note that the column index corresponds to the x-coordinate,
         and the row index corresponds to y; for details, see
-        the "Grid Orientation" section below.
+        :ref:`Grid Orientation <axes-pcolor-grid-orientation>`.
 
         Optional keyword arguments:
 
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -839,8 +839,8 @@ def set_data(self, x, y, A):
         """
         Set the grid for the pixel centers, and the pixel values.
 
-          *x* and *y* are 1-D ndarrays of lengths N and M, respectively,
-             specifying pixel centers
+          *x* and *y* are monotonic 1-D ndarrays of lengths N and M,
+             respectively, specifying pixel centers
 
           *A* is an (M,N) ndarray or masked array of values to be
             colormapped, or a (M,N,3) RGB array, or a (M,N,4) RGBA
@@ -959,6 +959,19 @@ def _check_unsampled_image(self, renderer):
         return False
 
     def set_data(self, x, y, A):
+        """
+        Set the grid for the rectangle boundaries, and the data values.
+
+          *x* and *y* are monotonic 1-D ndarrays of lengths N+1 and M+1,
+             respectively, specifying rectangle boundaries.  If None,
+             they will be created as uniform arrays from 0 through N
+             and 0 through M, respectively.
+
+          *A* is an (M,N) ndarray or masked array of values to be
+            colormapped, or a (M,N,3) RGB array, or a (M,N,4) RGBA
+            array.
+
+        """
         A = cbook.safe_masked_invalid(A, copy=True)
         if x is None:
             x = np.arange(0, A.shape[1]+1, dtype=np.float64)
