Skip to content

Commit 7de667c

Browse files
committed
DOC: Introduce backend versions
Closes matplotlib#30559.
1 parent dedfe9b commit 7de667c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

galleries/users_explain/figure/backends.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,35 @@ backend, use ``module://name.of.the.backend`` as the backend name, e.g.
253253

254254
Information for backend implementers is available at :ref:`writing_backend_interface`.
255255

256+
Backend API versions
257+
--------------------
258+
Matplotlib aims to maintain backward compatibility on backends. Nevertheless, we
259+
want to be able to evolve the backend API to support new features. Defining backend
260+
API versions will help to communicate which API is supported by a given version of
261+
Matplotlib.
262+
263+
The following backend API versions exist
264+
265+
.. list-table::
266+
:header-rows: 1
267+
268+
* - API version
269+
- Supported since
270+
- Description
271+
* - 1.0
272+
- Matplotlib 3.10
273+
- This is the starting point for systematic definition of backend versions.
274+
Most of the API will work far back, but there is no benefit in retroactively
275+
uncovering all prior the changes.
276+
* - 1.1
277+
- Matplotlib 3.11
278+
- `.RendererBase.draw_path_collection` gained a new optional parameter
279+
*hatchcolor*. The presence of the parameter is inferred by introspection, so
280+
that matplotlib 3.11+ will still work with backends implementing API version
281+
1.0.
282+
283+
There is currently no plan to remove support for older API versions.
284+
256285
.. _figures-not-showing:
257286

258287
Debugging the figure windows not showing

0 commit comments

Comments
 (0)