From ef3de6bf4ffde65c4761add36b23aec246c53530 Mon Sep 17 00:00:00 2001 From: Tanner Davis Date: Fri, 9 Apr 2021 10:53:33 -0600 Subject: [PATCH 1/4] PDF format docs, `append_images` param update [ci skip] Made sure it is documented that both the `append_images` and `save_all` params must be set. Just setting `append_images` does not work. --- docs/handbook/image-file-formats.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/handbook/image-file-formats.rst b/docs/handbook/image-file-formats.rst index c67f8fb8f44..cbeafe828a2 100644 --- a/docs/handbook/image-file-formats.rst +++ b/docs/handbook/image-file-formats.rst @@ -1242,8 +1242,9 @@ The :py:meth:`~PIL.Image.Image.save` method can take the following keyword argum .. versionadded:: 3.0.0 **append_images** - A list of images to append as additional pages. Each of the - images in the list can be single or multiframe images. + A list of :py:obj:`PIL.Image`s to append as additional pages. Each of the + images in the list can be single or multiframe images. The ``save_all`` + parameter must be present and set to ``True`` in conjunction with ``append_images``. .. versionadded:: 4.2.0 From 8da6eef073dcb0d493c8c2d39c2d285bd81993bf Mon Sep 17 00:00:00 2001 From: Tanner Davis Date: Fri, 9 Apr 2021 11:09:16 -0600 Subject: [PATCH 2/4] Made sure the rst link to the Image class was correct --- docs/handbook/image-file-formats.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/handbook/image-file-formats.rst b/docs/handbook/image-file-formats.rst index cbeafe828a2..1f91d220c3f 100644 --- a/docs/handbook/image-file-formats.rst +++ b/docs/handbook/image-file-formats.rst @@ -1242,7 +1242,7 @@ The :py:meth:`~PIL.Image.Image.save` method can take the following keyword argum .. versionadded:: 3.0.0 **append_images** - A list of :py:obj:`PIL.Image`s to append as additional pages. Each of the + A list of :py:obj:`PIL.Image.Image`s to append as additional pages. Each of the images in the list can be single or multiframe images. The ``save_all`` parameter must be present and set to ``True`` in conjunction with ``append_images``. From 8c38c80bb1b69563fda494a6493bfe6ee7c9d665 Mon Sep 17 00:00:00 2001 From: Tanner Davis Date: Fri, 9 Apr 2021 11:47:29 -0600 Subject: [PATCH 3/4] Now the rst link to the Image class should work --- docs/handbook/image-file-formats.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/handbook/image-file-formats.rst b/docs/handbook/image-file-formats.rst index 1f91d220c3f..9992c1339f0 100644 --- a/docs/handbook/image-file-formats.rst +++ b/docs/handbook/image-file-formats.rst @@ -1242,7 +1242,7 @@ The :py:meth:`~PIL.Image.Image.save` method can take the following keyword argum .. versionadded:: 3.0.0 **append_images** - A list of :py:obj:`PIL.Image.Image`s to append as additional pages. Each of the + A list of :py:class:`PIL.Image.Image`s to append as additional pages. Each of the images in the list can be single or multiframe images. The ``save_all`` parameter must be present and set to ``True`` in conjunction with ``append_images``. From 302ddc9b5e46249c2379bb44d1df19a52881cb80 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Sat, 10 Apr 2021 11:39:24 +1000 Subject: [PATCH 4/4] Corrected syntax --- docs/handbook/image-file-formats.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/handbook/image-file-formats.rst b/docs/handbook/image-file-formats.rst index 9992c1339f0..eb10a51fa4b 100644 --- a/docs/handbook/image-file-formats.rst +++ b/docs/handbook/image-file-formats.rst @@ -1242,9 +1242,10 @@ The :py:meth:`~PIL.Image.Image.save` method can take the following keyword argum .. versionadded:: 3.0.0 **append_images** - A list of :py:class:`PIL.Image.Image`s to append as additional pages. Each of the - images in the list can be single or multiframe images. The ``save_all`` - parameter must be present and set to ``True`` in conjunction with ``append_images``. + A list of :py:class:`PIL.Image.Image` objects to append as additional pages. Each + of the images in the list can be single or multiframe images. The ``save_all`` + parameter must be present and set to ``True`` in conjunction with + ``append_images``. .. versionadded:: 4.2.0