python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-12-26 01:46:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Andrew Murray 2021-07-10 00:36:24 +10:00
parent cf275737ee
commit d0a30ec369
2 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/ImagePalette.rst
View File

@ -9,10 +9,6 @@ represent the color palette of palette mapped images.
.. note:: .. note::
This module was never well-documented. It hasn't changed since 2001,
though, so it's probably safe for you to read the source code and puzzle
out the internals if you need to.
The :py:class:`~PIL.ImagePalette.ImagePalette` class has several methods, The :py:class:`~PIL.ImagePalette.ImagePalette` class has several methods,
but they are all marked as "experimental." Read that as you will. The but they are all marked as "experimental." Read that as you will. The
``[source]`` link is there for a reason. ``[source]`` link is there for a reason.

8
src/PIL/ImagePalette.py
View File

@ -25,12 +25,12 @@ class ImagePalette:
""" """
Color palette for palette mapped images Color palette for palette mapped images
:param mode: The mode to use for the Palette. See: :param mode: The mode to use for the palette. See:
:ref:`concept-modes`. Defaults to "RGB" :ref:`concept-modes`. Defaults to "RGB"
:param palette: An optional palette. If given, it must be a bytearray, :param palette: An optional palette. If given, it must be a bytearray,
an array or a list of ints between 0-255. The list must be aligned an array or a list of ints between 0-255. The list must consist of
by channel (All R values must be contiguous in the list before G all channels for one color followed by the next color (e.g. RGBRGBRGB).
and B values.) Defaults to 0 through 255 per channel. Defaults to an empty palette.
:param size: An optional palette size. If given, an error is raised :param size: An optional palette size. If given, an error is raised
if ``palette`` is not of equal length. if ``palette`` is not of equal length.
""" """