Merge pull request #24320 from tacaswell/doc_imsave_warning

anntzer · web-flow · commit 54d751bff624 · 2022-10-31T23:48:37.000+01:00
DOC: add warning note to imsave
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -1547,7 +1547,15 @@ def imread(fname, format=None):
 def imsave(fname, arr, vmin=None, vmax=None, cmap=None, format=None,
            origin=None, dpi=100, *, metadata=None, pil_kwargs=None):
     """
-    Save an array as an image file.
+    Colormap and save an array as an image file.
+
+    RGB(A) images are passed through.  Single channel images will be
+    colormapped according to *cmap* and *norm*.
+
+    .. note ::
+
+       If you want to save a single channel image as gray scale please use an
+       image I/O library (such as pillow, tifffile, or imageio) directly.
 
     Parameters
     ----------
