From bb639feffc86f9fe04b900dff7f5a56c00f3fa48 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Fri, 22 May 2026 18:55:43 +1000 Subject: [PATCH] Fixed typo Co-authored-by: him2him2 --- docs/deprecations.rst | 6 +++--- docs/handbook/image-file-formats.rst | 2 +- docs/handbook/writing-your-own-image-plugin.rst | 4 ++-- docs/reference/ExifTags.rst | 2 +- docs/reference/ImageChops.rst | 2 +- docs/reference/ImageDraw.rst | 4 ++-- docs/reference/ImageFilter.rst | 2 +- docs/reference/TiffTags.rst | 4 ++-- docs/reference/c_extension_debugging.rst | 6 +++--- docs/reference/limits.rst | 2 +- docs/releasenotes/10.4.0.rst | 2 +- docs/releasenotes/11.0.0.rst | 2 +- docs/releasenotes/11.2.1.rst | 4 ++-- docs/releasenotes/12.0.0.rst | 2 +- 14 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/deprecations.rst b/docs/deprecations.rst index b6a7af0a824..c73e6b9296b 100644 --- a/docs/deprecations.rst +++ b/docs/deprecations.rst @@ -25,7 +25,7 @@ Image.Image.get_child_images() .. deprecated:: 11.2.1 -``Image.Image.get_child_images()`` has been deprecated. and will be removed in Pillow +``Image.Image.get_child_images()`` has been deprecated, and will be removed in Pillow 13 (2026-10-15). It will be moved to ``ImageFile.ImageFile.get_child_images()``. The method uses an image's file pointer, and so child images could only be retrieved from an :py:class:`PIL.ImageFile.ImageFile` instance. @@ -157,7 +157,7 @@ ImageMath eval() ``ImageMath.eval()`` has been removed. Use :py:meth:`~PIL.ImageMath.lambda_eval` or :py:meth:`~PIL.ImageMath.unsafe_eval` instead. -BGR;15, BGR 16 and BGR;24 +BGR;15, BGR;16 and BGR;24 ^^^^^^^^^^^^^^^^^^^^^^^^^ .. deprecated:: 10.4.0 @@ -681,7 +681,7 @@ PyQt4 and PySide Qt 4 reached end-of-life on 2015-12-19. Its Python bindings are also EOL: PyQt4 since 2018-08-31 and PySide since 2015-10-14. -Support for PyQt4 and PySide has been removed from ``ImageQt``. Please upgrade to PyQt5 +Support for PyQt4 and PySide has been removed from ``ImageQt``. Please upgrade to PyQt5 or PySide2. Setting the size of TIFF images diff --git a/docs/handbook/image-file-formats.rst b/docs/handbook/image-file-formats.rst index a9fd764e613..9b65e324de5 100644 --- a/docs/handbook/image-file-formats.rst +++ b/docs/handbook/image-file-formats.rst @@ -449,7 +449,7 @@ Saving The :py:meth:`~PIL.Image.Image.save` method supports the following options: **sizes** - A list of sizes including in this ico file; these are a 2-tuple, + A list of sizes included in this ico file; these are a 2-tuple, ``(width, height)``; Default to ``[(16, 16), (24, 24), (32, 32), (48, 48), (64, 64), (128, 128), (256, 256)]``. Any sizes bigger than the original size or 256 will be ignored. diff --git a/docs/handbook/writing-your-own-image-plugin.rst b/docs/handbook/writing-your-own-image-plugin.rst index 21a9124d781..b615b5831b8 100644 --- a/docs/handbook/writing-your-own-image-plugin.rst +++ b/docs/handbook/writing-your-own-image-plugin.rst @@ -393,7 +393,7 @@ state structure, and a buffer of data to be transformed. It is the codec's responsibility to pull as much data as possible out of the buffer and return the number of bytes consumed. The next call to the codec will include the previous unconsumed tail. The codec function will be called -multiple times as the data processed. +multiple times as the data is processed. Alternatively, if ``pulls_fd`` or ``pushes_fd`` is set, then the decode or encode function is called once, with an empty buffer. It is the codec's @@ -446,7 +446,7 @@ Python-based file codec: is complete. This can be used to clean up any resources used by the codec. If you set ``_pulls_fd`` or ``_pushes_fd`` to ``True`` however, then you - probably chose to perform any cleanup tasks at the end of ``decode`` or + probably chose to perform any cleanup tasks at the end of ``decode`` or ``encode``. For an example :py:class:`PIL.ImageFile.PyDecoder`, see `DdsImagePlugin diff --git a/docs/reference/ExifTags.rst b/docs/reference/ExifTags.rst index e6bcd9d59c2..42fc816097b 100644 --- a/docs/reference/ExifTags.rst +++ b/docs/reference/ExifTags.rst @@ -38,7 +38,7 @@ EXIF tags. >>> IFD.Exif.value 34665 >>> IFD(34665).name - 'Exif + 'Exif' .. py:data:: LightSource diff --git a/docs/reference/ImageChops.rst b/docs/reference/ImageChops.rst index 505181db6b5..dd2741c644e 100644 --- a/docs/reference/ImageChops.rst +++ b/docs/reference/ImageChops.rst @@ -17,7 +17,7 @@ At this time, most channel operations are only implemented for 8-bit images Functions --------- -Most channel operations take one or two image arguments and returns a new +Most channel operations take one or two image arguments and return a new image. Unless otherwise noted, the result of a channel operation is always clipped to the range 0 to MAX (which is 255 for all modes supported by the operations in this module). diff --git a/docs/reference/ImageDraw.rst b/docs/reference/ImageDraw.rst index 4c956759334..d88e396e46e 100644 --- a/docs/reference/ImageDraw.rst +++ b/docs/reference/ImageDraw.rst @@ -106,9 +106,9 @@ contains font metrics, the latter raster data. To load a bitmap font, use the load functions in the :py:mod:`~PIL.ImageFont` module. -To load a OpenType/TrueType font, use the truetype function in the +To load an OpenType/TrueType font, use the truetype function in the :py:mod:`~PIL.ImageFont` module. Note that this function depends on third-party -libraries, and may not available in all PIL builds. +libraries, and may not be available in all PIL builds. Example: Draw partial opacity text ---------------------------------- diff --git a/docs/reference/ImageFilter.rst b/docs/reference/ImageFilter.rst index 1c201cacca4..d5146bc491f 100644 --- a/docs/reference/ImageFilter.rst +++ b/docs/reference/ImageFilter.rst @@ -5,7 +5,7 @@ ================================= The :py:mod:`~PIL.ImageFilter` module contains definitions for a pre-defined set of -filters, which can be be used with the :py:meth:`Image.filter() +filters, which can be used with the :py:meth:`Image.filter() ` method. Example: Filter an image diff --git a/docs/reference/TiffTags.rst b/docs/reference/TiffTags.rst index d75a4847897..6fe2071523b 100644 --- a/docs/reference/TiffTags.rst +++ b/docs/reference/TiffTags.rst @@ -14,7 +14,7 @@ metadata tag numbers, names, and type information. .. versionadded:: 8.3.0 - :returns: Taginfo namedtuple, From the :py:data:`~PIL.TiffTags.TAGS_V2` info if possible, + :returns: Taginfo namedtuple, from the :py:data:`~PIL.TiffTags.TAGS_V2` info if possible, otherwise just populating the value and name from :py:data:`~PIL.TiffTags.TAGS`. If the tag is not recognized, "unknown" is returned for the name @@ -59,7 +59,7 @@ metadata tag numbers, names, and type information. .. py:data:: PIL.TiffTags.TAGS :type: dict - The ``TAGS`` dictionary maps 16-bit integer TIFF tag number to + The ``TAGS`` dictionary maps 16-bit integer TIFF tag numbers to descriptive string names. For instance: >>> from PIL.TiffTags import TAGS diff --git a/docs/reference/c_extension_debugging.rst b/docs/reference/c_extension_debugging.rst index 12dca6cf2c9..c17806b69b8 100644 --- a/docs/reference/c_extension_debugging.rst +++ b/docs/reference/c_extension_debugging.rst @@ -64,7 +64,7 @@ Take your test image, and make a really simple harness. - Run this through valgrind, but note that python triggers some issues on its own, so you're looking for items within the Pillow hierarchy that don't look like they're solely in the python call chain. In this - example, the ones we're interested are after the warnings, and have + example, the ones we're interested in are after the warnings, and have ``decode.c`` and ``TiffDecode.c`` in the call stack: :: @@ -457,8 +457,8 @@ Caveats You probably won't have the capability to do that from within the docker container, as the trace capacity isn't allowed by default. -- Variations of this are possible on the mac/windows, but the details - are going to be different. +- Variations of this are possible on macOS/Windows, but the details are + going to be different. - IIRC, Fedora has the gdb bits working by default. Ubuntu has always been a bit of a battle to make it work. diff --git a/docs/reference/limits.rst b/docs/reference/limits.rst index d2f8f7d1fab..a1a005a556d 100644 --- a/docs/reference/limits.rst +++ b/docs/reference/limits.rst @@ -23,7 +23,7 @@ Internal limits * Individual memory mapped segments are limited to 2GB in map.c based on the overflow checks. This requires that any memory mapped image is smaller than 2GB, as calculated by ``y*stride`` (so 2Gpx for 'L' - images, and .5Gpx for 'RGB' + images, and .5Gpx for 'RGB') Format size limits ================== diff --git a/docs/releasenotes/10.4.0.rst b/docs/releasenotes/10.4.0.rst index 84a6091c96d..2916cf8ecbd 100644 --- a/docs/releasenotes/10.4.0.rst +++ b/docs/releasenotes/10.4.0.rst @@ -18,7 +18,7 @@ been added to all :py:class:`~PIL.ImageShow` viewers. Deprecations ============ -BGR;15, BGR 16 and BGR;24 +BGR;15, BGR;16 and BGR;24 ^^^^^^^^^^^^^^^^^^^^^^^^^ The experimental BGR;15, BGR;16 and BGR;24 modes have been deprecated. diff --git a/docs/releasenotes/11.0.0.rst b/docs/releasenotes/11.0.0.rst index 020fbf7df7d..04bf8416b35 100644 --- a/docs/releasenotes/11.0.0.rst +++ b/docs/releasenotes/11.0.0.rst @@ -132,7 +132,7 @@ XMP data can now be saved to JPEG files using an ``xmp`` argument:: im.save("out.jpg", xmp=b"test") -The data can also be set through :py:attr:`~PIL.Image.Image.info`, for use when saving +The data can also be set through :py:attr:`~PIL.Image.Image.info`, for use when saving either JPEG or MPO images:: im.info["xmp"] = b"test" diff --git a/docs/releasenotes/11.2.1.rst b/docs/releasenotes/11.2.1.rst index f55b0d7d776..aea2893aab2 100644 --- a/docs/releasenotes/11.2.1.rst +++ b/docs/releasenotes/11.2.1.rst @@ -27,7 +27,7 @@ Image.Image.get_child_images() .. deprecated:: 11.2.1 -``Image.Image.get_child_images()`` has been deprecated. and will be removed in Pillow +``Image.Image.get_child_images()`` has been deprecated, and will be removed in Pillow 13 (2026-10-15). It will be moved to ``ImageFile.ImageFile.get_child_images()``. The method uses an image's file pointer, and so child images could only be retrieved from an :py:class:`PIL.ImageFile.ImageFile` instance. @@ -38,7 +38,7 @@ API changes ``append_images`` no longer requires ``save_all`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Previously, ``save_all`` was required to in order to use ``append_images``. Now, +Previously, ``save_all`` was required in order to use ``append_images``. Now, ``save_all`` will default to ``True`` if ``append_images`` is not empty and the format supports saving multiple frames:: diff --git a/docs/releasenotes/12.0.0.rst b/docs/releasenotes/12.0.0.rst index 4c00d8c4cc1..eb1ce1d9d00 100644 --- a/docs/releasenotes/12.0.0.rst +++ b/docs/releasenotes/12.0.0.rst @@ -66,7 +66,7 @@ ImageMath eval() ``ImageMath.eval()`` has been removed. Use :py:meth:`~PIL.ImageMath.lambda_eval` or :py:meth:`~PIL.ImageMath.unsafe_eval` instead. -BGR;15, BGR 16 and BGR;24 +BGR;15, BGR;16 and BGR;24 ^^^^^^^^^^^^^^^^^^^^^^^^^ The experimental BGR;15, BGR;16 and BGR;24 modes have been removed.