Change the way API changes are documented

dstansby · dstansby · commit 6d03309cbc45 · 2019-09-27T12:36:20.000+01:00
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -25,8 +25,8 @@ added to Matplotlib, see :ref:`whats-new`.
 
       When a release is made
 
-       - All the files in 'next_api_changes/' should be moved to a single file in
-         'prev_api_changes/'.
+       - The files in 'next_api_changes/' should be moved to a new file in
+         'api_changes/'.
        - The include directive below should be changed to point to the new file
          created in the previous step.
 
diff --git a/doc/api/next_api_changes/behaviour.rst b/doc/api/next_api_changes/behaviour.rst
@@ -0,0 +1,2 @@
+Behaviour changes
+-----------------
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -0,0 +1,2 @@
+Deprecations
+------------
diff --git a/doc/api/next_api_changes/development.rst b/doc/api/next_api_changes/development.rst
@@ -0,0 +1,2 @@
+Development changes
+-------------------
diff --git a/doc/api/next_api_changes/removals.rst b/doc/api/next_api_changes/removals.rst
@@ -0,0 +1,2 @@
+Removals
+--------
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -36,7 +36,7 @@ Documentation
   :file:`doc/users/whats_new.rst`.
 
 * If you change the API in a backward-incompatible way, please
-  document it in :file:`doc/api/api_changes.rst`.
+  document it in the relevant file in :file:`doc/api/next_api_changes`.
 
 PR Review guidelines
 ====================
@@ -79,8 +79,8 @@ PR Review guidelines
   approve the review and if you think no more review is needed, merge
   the PR.
 
-  Ensure that all API changes are documented in
-  :file:`doc/api/api_changes` and significant new features have and
+  Ensure that all API changes are documented in the relevant file in
+  :file:`doc/api/next_api_changes` and significant new features have and
   entry in :file:`doc/user/whats_new`.
 
   - If a PR already has a positive review, a core developer (e.g. the first
diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst
@@ -267,8 +267,8 @@ rules before submitting a pull request:
   :file:`doc/users/next_whats_new/README.rst` for more information).
 
 * If you change the API in a backward-incompatible way, please document it in
-  `doc/api/api_changes`, by adding a new file describing your changes (see
-  :file:`doc/api/api_changes/README.rst` for more information)
+  :file:`doc/api/api_changes`, by adding to the relevant file
+  (see :file:`doc/api/api_changes/api_changes.rst` for more information)
 
 * See below for additional points about :ref:`keyword-argument-processing`, if
   applicable for your pull request.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Behaviour changes`
	`2`	`+-----------------`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Development changes`
	`2`	`+-------------------`