8000 Change the way API changes are documented · matplotlib/matplotlib@654a4a5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 654a4a5

Browse files
dstansbydstansby
committed
Change the way API changes are documented
1 parent 90fba03 commit 654a4a5

File tree

9 files changed

+21
-8
lines changed

9 files changed

+21
-8
lines changed

‎doc/api/api_changes.rst

Copy file name to clipboard
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ added to Matplotlib, see :ref:`whats-new`.
2525

2626
When a release is made
2727

28-
- All the files in 'next_api_changes/' should be moved to a single file in
29-
'prev_api_changes/'.
28+
- The files in 'next_api_changes/' should be moved to a new file in
29+
'api_changes/'.
3030
- The include directive below should be changed to point to the new file
3131
created in the previous step.
3232

@@ -37,4 +37,4 @@ added to Matplotlib, see :ref:`whats-new`.
3737

3838
next_api_changes/*
3939

40-
.. include:: prev_api_changes/api_changes_3.2.0.rst
40+
.. include:: api_changes/api_changes_3.2.0.rst

‎doc/api/api_changes/2019-02-11-PGE.rst renamed to ‎doc/api/next_api_changes/2019-02-11-PGE.rst

File renamed without changes.

‎doc/api/next_api_changes/2019-06-26-AL.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Deprecations
2+
````````````
3+
4+
``Affine2DBase.matrix_from_values(...)`` is deprecated. Use (for example)
5+
``Affine2D.from_values(...).get_matrix()`` instead.

‎doc/api/next_api_changes/behaviour.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Behaviour changes
2+
-----------------

‎doc/api/next_api_changes/deprecations.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Deprecations
2+
------------

‎doc/api/next_api_changes/development.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Development changes
2+
-------------------

‎doc/api/next_api_changes/removals.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Removals
2+
--------

‎doc/devel/coding_guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Documentation
3636
:file:`doc/users/whats_new.rst`.
3737

3838
* If you change the API in a backward-incompatible way, please
39-
document it in :file:`doc/api/api_changes.rst`.
39+
document it in the relevant file in :file:`doc/api/next_api_changes`.
4040

4141
PR Review guidelines
4242
====================
@@ -79,8 +79,8 @@ PR Review guidelines
7979
approve the review and if you think no more review is needed, merge
8080
the PR.
8181

82-
Ensure that all API changes are documented in
83-
:file:`doc/api/api_changes` and significant new features have and
82+
Ensure that all API changes are documented in the relevant file in
83+
:file:`doc/api/next_api_changes` and significant new features have and
8484
entry in :file:`doc/user/whats_new`.
8585

8686
- If a PR already has a positive review, a core developer (e.g. the first

‎doc/devel/contributing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,8 @@ rules before submitting a pull request:
267267
:file:`doc/users/next_whats_new/README.rst` for more information).
268268

269269
* If you change the API in a backward-incompatible way, please document it in
270-
`doc/api/api_changes`, by adding a new file describing your changes (see
271-
:file:`doc/api/api_changes/README.rst` for more information)
270+
:file:`doc/api/api_changes`, by adding to the relevant file
271+
(see :file:`doc/api/api_changes/api_changes.rst` for more information)
272272

273273
* See below for additional points about :ref:`keyword-argument-processing`, if
274274
applicable for your pull request.

0 commit comments

Comments
 (0)
0