Skip to content

Commit c55d5d2

Browse files
committed
Document requirements.txt -> extras_require in release notes
1 parent 7566f8c commit c55d5d2

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

docs/releasenotes/9.1.0.rst

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,31 @@ Rather than returning a ``SystemError``, passing the incorrect types of coordina
1818
a path will now raise a more specific ``ValueError``, with the message "incorrect
1919
coordinate type".
2020

21+
Replace requirements.txt with extras
22+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
23+
24+
Rather than installing all dependencies for docs and tests via ``requirements.txt``,
25+
``extras_require`` is used instead. This installs only those needed and at the same
26+
time as installing Pillow.
27+
28+
For example:
29+
30+
.. code-block:: bash
31+
32+
# Install with dependencies for tests:
33+
python3 -m pip install .[tests]
34+
35+
# Or for building docs:
36+
python3 -m pip install .[docs]
37+
38+
# Or for all:
39+
python3 -m pip install .[docs,tests]
40+
41+
Therefore ``requirements.txt`` has been removed along with the ``make install-req``
42+
command for installing its contents.
43+
2144
Deprecations
22-
^^^^^^^^^^^^
45+
============
2346

2447
Constants
2548
~~~~~~~~~
@@ -87,7 +110,7 @@ Deprecated Use instead
87110
===================================================== ============================================================
88111

89112
ImageShow.Viewer.show_file file argument
90-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
91114

92115
The ``file`` argument in :py:meth:`~PIL.ImageShow.Viewer.show_file()` has been
93116
deprecated and will be removed in Pillow 10.0.0 (2023-07-01). It has been replaced by

0 commit comments

Comments
 (0)