improved docstring for SegmentedBivarColormap()

trygvrad · trygvrad · commit dcf6f8a1b572 · 2024-08-19T10:48:36.000+02:00
also allows SegmentedBivarColormap to take non-square patches.
This was easier that testing that the input is always square.
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -760,9 +760,10 @@ def _get_rgba_and_mask(self, X, alpha=None, bytes=False):
 
         Returns
         -------
-        colors : array of RGBA values with a shape of ``X.shape + (4, )``.
-        mask : boolean array with True where the input is ``np.nan`` or
-            masked.
+        colors : np.ndarray
+            Array of RGBA values with a shape of ``X.shape + (4, )``.
+        mask : np.ndarray
+            Boolean array with True where the input is ``np.nan`` or masked.
         """
         if not self._isinit:
             self._init()
@@ -2016,8 +2017,9 @@ class SegmentedBivarColormap(BivarColormap):
 
     Parameters
     ----------
-    patch : np.array of shape (k, k, 3)
-        This patch gets supersampled to a lut of shape (N, M, 4).
+    patch : np.array
+        Patch is required to have a shape (k, l, 3), and will get supersampled
+        to a lut of shape (N, N, 4).
     N : int
         The number of RGB quantization levels along each axis.
     shape : {'square', 'circle', 'ignore', 'circleignore'}
@@ -2051,7 +2053,7 @@ def _init(self):
         _patch[:, :, :3] = self.patch
         _patch[:, :, 3] = 1
         transform = mpl.transforms.Affine2D().translate(-0.5, -0.5)\
-                                .scale(self.N / (s[0] - 1), self.N / (s[0] - 1))
+                                .scale(self.N / (s[1] - 1), self.N / (s[0] - 1))
         self._lut = np.empty((self.N, self.N, 4))
 
         _image.resample(_patch, self._lut, transform, _image.BILINEAR,
