Skip to content

Commit 4c435a6

Browse files
tacaswelldstansbyQuLogic
committed
DOC: document where to touch to bump numpy/Python version
Co-authored-by: David Stansby <dstansby@gmail.com> Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
1 parent dc45354 commit 4c435a6

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

doc/devel/min_dep_policy.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,3 +155,50 @@ Matplotlib Python NumPy
155155
.. _`1.5`: https://matplotlib.org/1.5.0/users/installing.html#required-dependencies
156156
.. _`1.4`: https://matplotlib.org/1.4.0/users/installing.html#required-dependencies
157157
.. _`1.3`: https://matplotlib.org/1.3.0/users/installing.html#build-requirements
158+
159+
160+
Updating Python and NumPy versions
161+
==================================
162+
163+
To update the minimum versions of Python we need to update:
164+
165+
- ``pyproject.toml`` (classifiers, requires-python, ``[ruff.tool]`` target-version)
166+
- ``environment.yml``
167+
- ``doc/install/dependencies.rst``
168+
- ``doc/devel/min_dep_policy.rst`` (this file)
169+
- CI configuration files (circle, GHA, azure)
170+
- ``tox.ini``
171+
172+
To update the minimum NumPy we need to update:
173+
174+
- ``pyproject.toml``
175+
- ``environment.yml``
176+
- ``doc/install/dependencies.rst``
177+
- ``doc/devel/min_dep_policy.rst`` (this file)
178+
- ``requirements/testing/minver.txt``
179+
- ``lib/matplotlib/__init__.py`` (matplotlib._check_versions())
180+
181+
182+
The work to leverage new features or remove workarounds for no-longer supported
183+
versions should be done in a follow-on PRs to keep the version bump PRs well
184+
scoped.
185+
186+
In both cases add an api_changes/development with the following template:
187+
188+
.. code-block:: rst
189+
190+
Increase to minimum supported versions of dependencies
191+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192+
193+
For Matplotlib 3.ZZ, the :ref:`minimum supported versions <dependencies>` are
194+
being bumped:
195+
196+
+------------+-----------------+----------------+
197+
| Dependency | min in mpl3.N | min in mpl3.M |
198+
+============+=================+================+
199+
| Python | 3.XX | 3.AA |
200+
| NumPy | 1.YY | 1.BB |
201+
+------------+-----------------+----------------+
202+
203+
This is consistent with our :ref:`min_deps_policy` and `SPEC0
204+
<https://scientific-python.org/specs/spec-0000/>`__

0 commit comments

Comments
 (0)