Corrected "optimize" default when saving GIF images

This commit is contained in:
Andrew Murray 2023-11-25 17:30:09 +11:00
parent 04a4d54275
commit c855584dac

View File

@ -266,9 +266,12 @@ following options are available::
:py:class:`PIL.ImagePalette.ImagePalette` object. :py:class:`PIL.ImagePalette.ImagePalette` object.
**optimize** **optimize**
If present and true, attempt to compress the palette by Whether to attempt to compress the palette by eliminating unused colors.
eliminating unused colors. This is only useful if the palette can This is attempted by default, unless a palette is specified as an option or
be compressed to the next smaller power of 2 elements. as part of the first image's :py:attr:`~PIL.Image.Image.info` dictionary.
This is only useful if the palette can be compressed to the next smaller
power of 2 elements.
Note that if the image you are saving comes from an existing GIF, it may have Note that if the image you are saving comes from an existing GIF, it may have
the following properties in its :py:attr:`~PIL.Image.Image.info` dictionary. the following properties in its :py:attr:`~PIL.Image.Image.info` dictionary.