8000 Update API changes page · matplotlib/matplotlib@21f214a · GitHub
[go: up one dir, main page]

Skip to content

Commit 21f214a

Browse files
dstansbytacaswell
authored andcommitted
Update API changes page
1 parent de39b3d commit 21f214a

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

doc/api/api_changes.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,18 @@
33
API Changes
44
===========
55

6-
A log of changes to the most recent version of Matplotlib that affect the
7-
outward-facing API. If updating Matplotlib breaks your scripts, this list may
8-
help you figure out what caused the breakage and how to fix it by updating
9-
your code. For API changes in older versions see :doc:`api_changes_old`.
6+
If updating Matplotlib breaks your scripts, this list may help you figure out
7+
what caused the breakage and how to fix it by updating your code.
108

11-
For new features that were added to Matplotlib, see :ref:`whats-new`.
12-
13-
This pages lists API changes for the most recent version of Matplotlib.
9+
For API changes in older versions see
1410

1511
.. toctree::
1612
:maxdepth: 1
1713

1814
api_changes_old
1915

16+
Changes for the latest version are listed below. For new features that were
17+
added to Matplotlib, see :ref:`whats-new`.
2018

2119
.. note::
2220

@@ -25,14 +23,17 @@ This pages lists API changes for the most recent version of Matplotlib.
2523

2624
When a release is made
2725

28-
- The full text list below should be moved into its own file in
29-
'prev_api_changes'
30-
- All the files in 'next_api_changes' should be moved to the bottom of this page
31-
- This note, and the toctree below should be commented out
26+
- All the files in 'next_api_changes/' should be moved to a single file in
27+
'prev_api_changes/'.
28+
- The include directive below should be changed to point to the new file
29+
created in the previous step.
30+
- This note, and the toctree below should be commented out.
3231

3332

3433
.. toctree::
3534
:glob:
3635
:maxdepth: 1
3736

3837
next_api_changes/*
38+
39+
.. include:: prev_api_changes/api_changes_3.1.0.rst

doc/api/prev_api_changes/api_changes_3.1.0.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
API Changes for 3.1.0
2+
=====================
3+
14
API removals
25
------------
36

@@ -353,7 +356,7 @@ The following keyword arguments are deprecated:
353356
`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface` is deprecated. This was
354357
an unintended implementation detail with the same semantics as
355358
``shade=False``. Please use the latter code instead.API removals
356-
````````````
359+
357360

358361
The following deprecated APIs were removed:
359362

0 commit comments

Comments
 (0)
0