Skip to content

Commit bdbc7fb

Browse files
committed
Added release notes for #5959
1 parent 169ecc3 commit bdbc7fb

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

docs/releasenotes/9.1.0.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,37 @@ API Changes
55
===========
66

77
Raise an error when performing a negative crop
8-
----------------------------------------------
8+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99

1010
Performing a negative crop on an image previously just returned a `(0, 0)` image. Now
1111
it will raise a `ValueError`, to help reduce confusion if a user has unintentionally
1212
provided the wrong arguments.
1313

1414
Added specific error if path coordinate type is incorrect
15-
---------------------------------------------------------
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616

1717
Rather than returning a `SystemError`, passing the incorrect types of coordinates into
1818
a path will now raise a more specific `ValueError`, with the message "incorrect
1919
coordinate type".
2020

21+
Deprecations
22+
^^^^^^^^^^^^
23+
24+
ImageShow.Viewer.show_file file argument
25+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26+
27+
The ``file`` argument in :py:meth:`~PIL.ImageShow.Viewer.show_file()` has been
28+
deprecated, replaced by ``path``.
29+
30+
In effect, ``viewer.show_file("test.jpg")`` will continue to work unchanged.
31+
``viewer.show_file(file="test.jpg")`` will raise a deprecation warning, and suggest
32+
``viewer.show_file(path="test.jpg")`` instead.
33+
2134
API Additions
2235
=============
2336

2437
Added get_photoshop_blocks() to parse Photoshop TIFF tag
25-
--------------------------------------------------------
38+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2639

2740
:py:meth:`~PIL.TiffImagePlugin.TiffImageFile.get_photoshop_blocks` has been added, to
2841
allow users to determine what Photoshop "Image Resource Blocks" are contained within an
@@ -36,7 +49,7 @@ Other Changes
3649
=============
3750

3851
Image._repr_pretty_
39-
-------------------
52+
^^^^^^^^^^^^^^^^^^^
4053

4154
:py:meth:`~PIL.Image.Image._repr_pretty_` has been added to provide a representation of
4255
an image without the identity of the object. This allows Jupyter to describe an image

0 commit comments

Comments
 (0)