Merge pull request #5352 from radarhere/quantize_documentation

python-pillow · Mar 26, 2021 · 9b69d94 · 9b69d94
2 parents d402112 + 0ff9879
commit 9b69d94
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/docs/reference/Image.rst b/docs/reference/Image.rst
@@ -486,15 +486,16 @@ Used to specify the quantization method to use for the :meth:`~Image.quantize` m
 
 .. data:: MEDIANCUT
 
-    Median cut
+    Median cut. Default method, except for RGBA images. This method does not support
+    RGBA images.
 
 .. data:: MAXCOVERAGE
 
-    Maximum coverage
+    Maximum coverage. This method does not support RGBA images.
 
 .. data:: FASTOCTREE
 
-    Fast octree
+    Fast octree. Default method for RGBA images.
 
 .. data:: LIBIMAGEQUANT
 

diff --git a/src/PIL/Image.py b/src/PIL/Image.py
@@ -1059,6 +1059,12 @@ def quantize(self, colors=256, method=None, kmeans=0, palette=None, dither=1):
                        :data:`LIBIMAGEQUANT` (libimagequant; check support using
                        :py:func:`PIL.features.check_feature`
                        with ``feature="libimagequant"``).
+
+                       By default, :data:`MEDIANCUT` will be used.
+
+                       The exception to this is RGBA images. :data:`MEDIANCUT` and
+                       :data:`MAXCOVERAGE` do not support RGBA images, so
+                       :data:`FASTOCTREE` is used by default instead.
         :param kmeans: Integer
         :param palette: Quantize to the palette of given
                         :py:class:`PIL.Image.Image`.