python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-01-27 01:34:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Changed docstrings to be consistent

Co-Authored-By: radarhere <3112309+radarhere@users.noreply.github.com>
This commit is contained in:
Hugo 2019-01-01 20:42:23 +11:00 committed by GitHub
parent aa8f30eae8
commit 2de101e02c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/PIL/ImageChops.py
View File

@ -54,7 +54,7 @@ def invert(image):
def lighter(image1, image2): def lighter(image1, image2):
""" """
Compares the two images, pixel by pixel, and returns a new image containing Compares the two images, pixel by pixel, and returns a new image containing
the lighter values. Note that at least one of the images must have mode "1". the lighter values. At least one of the images must have mode "1".
.. code-block:: python .. code-block:: python
@ -71,7 +71,7 @@ def lighter(image1, image2):
def darker(image1, image2): def darker(image1, image2):
""" """
Compares the two images, pixel by pixel, and returns a new image containing Compares the two images, pixel by pixel, and returns a new image containing
the darker values. Note that at least one of the images must have mode "1". the darker values. At least one of the images must have mode "1".
.. code-block:: python .. code-block:: python
@ -88,7 +88,7 @@ def darker(image1, image2):
def difference(image1, image2): def difference(image1, image2):
""" """
Returns the absolute value of the pixel-by-pixel difference between the two Returns the absolute value of the pixel-by-pixel difference between the two
images. At least one of the images must be "1" mode. images. At least one of the images must have mode "1".
.. code-block:: python .. code-block:: python
@ -125,7 +125,7 @@ def multiply(image1, image2):
def screen(image1, image2): def screen(image1, image2):
""" """
Superimposes two inverted images on top of each other. At least one of the Superimposes two inverted images on top of each other. At least one of the
images must be "1" mode. images must have mode "1".
.. code-block:: python .. code-block:: python
@ -143,7 +143,7 @@ def add(image1, image2, scale=1.0, offset=0):
""" """
Adds two images, dividing the result by scale and adding the Adds two images, dividing the result by scale and adding the
offset. If omitted, scale defaults to 1.0, and offset to 0.0. offset. If omitted, scale defaults to 1.0, and offset to 0.0.
At least one of the images must be "1" mode. At least one of the images must have mode "1".
.. code-block:: python .. code-block:: python
@ -161,7 +161,7 @@ def subtract(image1, image2, scale=1.0, offset=0):
""" """
Subtracts two images, dividing the result by scale and adding the offset. Subtracts two images, dividing the result by scale and adding the offset.
If omitted, scale defaults to 1.0, and offset to 0.0. At least one of the If omitted, scale defaults to 1.0, and offset to 0.0. At least one of the
images must be "1" mode. images must have mode "1".
.. code-block:: python .. code-block:: python
@ -177,7 +177,7 @@ def subtract(image1, image2, scale=1.0, offset=0):
def add_modulo(image1, image2): def add_modulo(image1, image2):
"""Add two images, without clipping the result. At least one of the images """Add two images, without clipping the result. At least one of the images
must be "1" mode. must have mode "1".
.. code-block:: python .. code-block:: python
@ -193,7 +193,7 @@ def add_modulo(image1, image2):
def subtract_modulo(image1, image2): def subtract_modulo(image1, image2):
"""Subtract two images, without clipping the result. At least one of the """Subtract two images, without clipping the result. At least one of the
images must be "1" mode. images must have mode "1".
.. code-block:: python .. code-block:: python
@ -208,8 +208,8 @@ def subtract_modulo(image1, image2):
def logical_and(image1, image2): def logical_and(image1, image2):
"""Logical AND between two images. At least one of the images must be "1" """Logical AND between two images. At least one of the images must have
mode. mode "1".
.. code-block:: python .. code-block:: python
@ -224,8 +224,8 @@ def logical_and(image1, image2):
def logical_or(image1, image2): def logical_or(image1, image2):
"""Logical OR between two images. At least one of the images must be "1" """Logical OR between two images. At least one of the images must have
mode. mode "1".
.. code-block:: python .. code-block:: python
@ -240,8 +240,8 @@ def logical_or(image1, image2):
def logical_xor(image1, image2): def logical_xor(image1, image2):
"""Logical XOR between two images. At least one of the images must be "1" """Logical XOR between two images. At least one of the images must have
mode. mode "1".
.. code-block:: python .. code-block:: python