Merge pull request #20238 from timhoffm/doc-set_array

jklymak · web-flow · commit 75c425c425d5 · 2021-05-16T12:37:11.000-07:00
Clarify docstring of ScalarMappable.set/get_array()
diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py
@@ -361,11 +361,15 @@ def to_rgba(self, x, alpha=None, bytes=False, norm=True):
 
     def set_array(self, A):
         """
-        Set the image array from array-like *A*.
+        Set the value array from array-like *A*.
 
         Parameters
         ----------
         A : array-like or None
+            The values that are mapped to colors.
+
+            The base class `.ScalarMappable` does not make any assumptions on
+            the dimensionality and shape of the value array *A*.
         """
         if A is None:
             self._A = None
@@ -379,7 +383,12 @@ def set_array(self, A):
         self._A = A
 
     def get_array(self):
-        """Return the data array."""
+        """
+        Return the array of values, that are mapped to colors.
+
+        The base class `.ScalarMappable` does not make any assumptions on
+        the dimensionality and shape of the array.
+        """
         return self._A
 
     def get_cmap(self):
