From 45252f128b297a1828437d858b194fdafdf0e972 Mon Sep 17 00:00:00 2001 From: Sidharth Date: Sat, 4 Apr 2020 03:00:39 +0530 Subject: [PATCH 1/9] Rename next_api_changes to api_changes_3.3 --- doc/api/api_changes.rst | 2 +- .../{next_api_changes => api_changes_3.3}/2019-04-25-AL.rst | 0 doc/api/{next_api_changes => api_changes_3.3}/README.rst | 3 +-- doc/api/{next_api_changes => api_changes_3.3}/behaviour.rst | 0 .../{next_api_changes => api_changes_3.3}/deprecations.rst | 0 doc/api/{next_api_changes => api_changes_3.3}/development.rst | 0 doc/api/{next_api_changes => api_changes_3.3}/removals.rst | 0 doc/devel/coding_guide.rst | 4 ++-- doc/devel/contributing.rst | 2 +- doc/devel/release_guide.rst | 2 +- 10 files changed, 6 insertions(+), 7 deletions(-) rename doc/api/{next_api_changes => api_changes_3.3}/2019-04-25-AL.rst (100%) rename doc/api/{next_api_changes => api_changes_3.3}/README.rst (94%) rename doc/api/{next_api_changes => api_changes_3.3}/behaviour.rst (100%) rename doc/api/{next_api_changes => api_changes_3.3}/deprecations.rst (100%) rename doc/api/{next_api_changes => api_changes_3.3}/development.rst (100%) rename doc/api/{next_api_changes => api_changes_3.3}/removals.rst (100%) diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst index 907217713be6..4e7561f715df 100644 --- a/doc/api/api_changes.rst +++ b/doc/api/api_changes.rst @@ -21,7 +21,7 @@ added to Matplotlib, see :ref:`whats-new`. .. note:: The list below is a table of contents of individual files from the - 'next_api_changes' folder. + 'api_changes_3.3' folder. When a release is made diff --git a/doc/api/next_api_changes/2019-04-25-AL.rst b/doc/api/api_changes_3.3/2019-04-25-AL.rst similarity index 100% rename from doc/api/next_api_changes/2019-04-25-AL.rst rename to doc/api/api_changes_3.3/2019-04-25-AL.rst diff --git a/doc/api/next_api_changes/README.rst b/doc/api/api_changes_3.3/README.rst similarity index 94% rename from doc/api/next_api_changes/README.rst rename to doc/api/api_changes_3.3/README.rst index 5c3171edea27..09224a836783 100644 --- a/doc/api/next_api_changes/README.rst +++ b/doc/api/api_changes_3.3/README.rst @@ -4,7 +4,7 @@ Adding API change notes ======================= API change notes for future releases are collected in the directory -:file:`next_api_changes`. They are divided into four categories: +:file:`api_changes_3.3`. They are divided into four categories: - **Deprecations**: Announcements of future changes. Typically, these will raise a deprecation warning and users of this API should change their code @@ -27,4 +27,3 @@ A typical entry could look like this:: ~~~~~~~~ The unused `Locator.autoscale()` method is deprecated (pass the axis limits to `Locator.view_limits()` instead). - diff --git a/doc/api/next_api_changes/behaviour.rst b/doc/api/api_changes_3.3/behaviour.rst similarity index 100% rename from doc/api/next_api_changes/behaviour.rst rename to doc/api/api_changes_3.3/behaviour.rst diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/api_changes_3.3/deprecations.rst similarity index 100% rename from doc/api/next_api_changes/deprecations.rst rename to doc/api/api_changes_3.3/deprecations.rst diff --git a/doc/api/next_api_changes/development.rst b/doc/api/api_changes_3.3/development.rst similarity index 100% rename from doc/api/next_api_changes/development.rst rename to doc/api/api_changes_3.3/development.rst diff --git a/doc/api/next_api_changes/removals.rst b/doc/api/api_changes_3.3/removals.rst similarity index 100% rename from doc/api/next_api_changes/removals.rst rename to doc/api/api_changes_3.3/removals.rst diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index c5140ac6bc82..78fdbd86b3a4 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -95,7 +95,7 @@ Documentation :file:`doc/users/whats_new.rst`. * If you change the API in a backward-incompatible way, please - document it in the relevant file in :file:`doc/api/next_api_changes`. + document it in the relevant file in :file:`doc/api/api_changes_3.3`. .. _pr-labels: @@ -145,7 +145,7 @@ Merging the PR. Ensure that all API changes are documented in the relevant file in - :file:`doc/api/next_api_changes` and significant new features have and + :file:`doc/api/api_changes_3.3` 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 index ab2360393a5e..617116a86aaa 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -318,7 +318,7 @@ Changes to the public API must follow a standard deprecation procedure to prevent unexpected breaking of code that uses Matplotlib. - Deprecations must be announced via an entry in - :file:`doc/api/next_api_changes`. + :file:`doc/api/api_changes_3.3`. - Deprecations are targeted at the next point-release (i.e. 3.x.0). - The deprecated API should, to the maximum extent possible, remain fully functional during the deprecation period. In cases where this is not diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index c287b92d135b..b4ebbdcff874 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -112,7 +112,7 @@ For the "what's new", Similarly for the "API changes", 1. copy the current api changes to a file is :file:`doc/api/prev_api_changes` - 2. merge all of the files in :file:`doc/api/next_api_changes/` into + 2. merge all of the files in :file:`doc/api/api_changes_3.3/` into :file:`doc//whats_new.rst` 3. comment out the next API changes at the top. From 04e9e4f9b7ca75c0843511944edecf9eaa3efbcf Mon Sep 17 00:00:00 2001 From: Sidharth Date: Sat, 4 Apr 2020 15:04:37 +0530 Subject: [PATCH 2/9] prepend recent_ in filename --- doc/api/api_changes.rst | 2 +- .../2019-04-25-AL.rst | 0 .../{api_changes_3.3 => recent_api_changes_3.3}/README.rst | 2 +- .../{api_changes_3.3 => recent_api_changes_3.3}/behaviour.rst | 0 .../deprecations.rst | 0 .../development.rst | 0 .../{api_changes_3.3 => recent_api_changes_3.3}/removals.rst | 0 doc/devel/coding_guide.rst | 4 ++-- doc/devel/contributing.rst | 2 +- doc/devel/release_guide.rst | 2 +- 10 files changed, 6 insertions(+), 6 deletions(-) rename doc/api/{api_changes_3.3 => recent_api_changes_3.3}/2019-04-25-AL.rst (100%) rename doc/api/{api_changes_3.3 => recent_api_changes_3.3}/README.rst (93%) rename doc/api/{api_changes_3.3 => recent_api_changes_3.3}/behaviour.rst (100%) rename doc/api/{api_changes_3.3 => recent_api_changes_3.3}/deprecations.rst (100%) rename doc/api/{api_changes_3.3 => recent_api_changes_3.3}/development.rst (100%) rename doc/api/{api_changes_3.3 => recent_api_changes_3.3}/removals.rst (100%) diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst index 4e7561f715df..327d0c7a8965 100644 --- a/doc/api/api_changes.rst +++ b/doc/api/api_changes.rst @@ -21,7 +21,7 @@ added to Matplotlib, see :ref:`whats-new`. .. note:: The list below is a table of contents of individual files from the - 'api_changes_3.3' folder. + 'recent_api_changes_3.3' folder. When a release is made diff --git a/doc/api/api_changes_3.3/2019-04-25-AL.rst b/doc/api/recent_api_changes_3.3/2019-04-25-AL.rst similarity index 100% rename from doc/api/api_changes_3.3/2019-04-25-AL.rst rename to doc/api/recent_api_changes_3.3/2019-04-25-AL.rst diff --git a/doc/api/api_changes_3.3/README.rst b/doc/api/recent_api_changes_3.3/README.rst similarity index 93% rename from doc/api/api_changes_3.3/README.rst rename to doc/api/recent_api_changes_3.3/README.rst index 09224a836783..6b65d8a1f558 100644 --- a/doc/api/api_changes_3.3/README.rst +++ b/doc/api/recent_api_changes_3.3/README.rst @@ -4,7 +4,7 @@ Adding API change notes ======================= API change notes for future releases are collected in the directory -:file:`api_changes_3.3`. They are divided into four categories: +:file:`recent_api_changes_3.3`. They are divided into four categories: - **Deprecations**: Announcements of future changes. Typically, these will raise a deprecation warning and users of this API should change their code diff --git a/doc/api/api_changes_3.3/behaviour.rst b/doc/api/recent_api_changes_3.3/behaviour.rst similarity index 100% rename from doc/api/api_changes_3.3/behaviour.rst rename to doc/api/recent_api_changes_3.3/behaviour.rst diff --git a/doc/api/api_changes_3.3/deprecations.rst b/doc/api/recent_api_changes_3.3/deprecations.rst similarity index 100% rename from doc/api/api_changes_3.3/deprecations.rst rename to doc/api/recent_api_changes_3.3/deprecations.rst diff --git a/doc/api/api_changes_3.3/development.rst b/doc/api/recent_api_changes_3.3/development.rst similarity index 100% rename from doc/api/api_changes_3.3/development.rst rename to doc/api/recent_api_changes_3.3/development.rst diff --git a/doc/api/api_changes_3.3/removals.rst b/doc/api/recent_api_changes_3.3/removals.rst similarity index 100% rename from doc/api/api_changes_3.3/removals.rst rename to doc/api/recent_api_changes_3.3/removals.rst diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 78fdbd86b3a4..3e3cc3d9dfc3 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -95,7 +95,7 @@ Documentation :file:`doc/users/whats_new.rst`. * If you change the API in a backward-incompatible way, please - document it in the relevant file in :file:`doc/api/api_changes_3.3`. + document it in the relevant file in :file:`doc/api/recent_api_changes_3.3`. .. _pr-labels: @@ -145,7 +145,7 @@ Merging the PR. Ensure that all API changes are documented in the relevant file in - :file:`doc/api/api_changes_3.3` and significant new features have and + :file:`doc/api/recent_api_changes_3.3` 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 index 617116a86aaa..edeb1c03446e 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -318,7 +318,7 @@ Changes to the public API must follow a standard deprecation procedure to prevent unexpected breaking of code that uses Matplotlib. - Deprecations must be announced via an entry in - :file:`doc/api/api_changes_3.3`. + :file:`doc/api/recent_api_changes_3.3`. - Deprecations are targeted at the next point-release (i.e. 3.x.0). - The deprecated API should, to the maximum extent possible, remain fully functional during the deprecation period. In cases where this is not diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index b4ebbdcff874..9590e9c1d20c 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -112,7 +112,7 @@ For the "what's new", Similarly for the "API changes", 1. copy the current api changes to a file is :file:`doc/api/prev_api_changes` - 2. merge all of the files in :file:`doc/api/api_changes_3.3/` into + 2. merge all of the files in :file:`doc/api/recent_api_changes_3.3/` into :file:`doc//whats_new.rst` 3. comment out the next API changes at the top. From 4ed46968051527a1a7fc24af9bc11f69be7c1f48 Mon Sep 17 00:00:00 2001 From: Sidharth Date: Sat, 4 Apr 2020 15:44:02 +0530 Subject: [PATCH 3/9] prepend recent_ in filename --- doc/api/api_changes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst index 327d0c7a8965..73383d103c16 100644 --- a/doc/api/api_changes.rst +++ b/doc/api/api_changes.rst @@ -25,7 +25,7 @@ added to Matplotlib, see :ref:`whats-new`. When a release is made - - The files in 'next_api_changes/' should be moved to a new file in + - The files in 'recent_api_changes_3.3/' should be moved to a new file in 'prev_api_changes/'. - The include directive below should be changed to point to the new file created in the previous step. @@ -35,6 +35,6 @@ added to Matplotlib, see :ref:`whats-new`. :glob: :maxdepth: 1 - next_api_changes/* + recent_api_changes_3.3/* .. include:: prev_api_changes/api_changes_3.2.0.rst From 020281c4a54929a6807158804a2e8ae2f37b439e Mon Sep 17 00:00:00 2001 From: Sidharth Date: Sun, 5 Apr 2020 00:37:45 +0530 Subject: [PATCH 4/9] Changed text --- doc/api/api_changes.rst | 8 ++++---- .../2019-04-25-AL.rst | 0 .../README.rst | 4 ++-- .../behaviour.rst | 0 .../deprecations.rst | 0 .../development.rst | 0 .../removals.rst | 0 doc/devel/coding_guide.rst | 7 ++++--- doc/devel/contributing.rst | 2 +- doc/devel/release_guide.rst | 4 ++-- 10 files changed, 13 insertions(+), 12 deletions(-) rename doc/api/{recent_api_changes_3.3 => api_changes_3.3}/2019-04-25-AL.rst (100%) rename doc/api/{recent_api_changes_3.3 => api_changes_3.3}/README.rst (87%) rename doc/api/{recent_api_changes_3.3 => api_changes_3.3}/behaviour.rst (100%) rename doc/api/{recent_api_changes_3.3 => api_changes_3.3}/deprecations.rst (100%) rename doc/api/{recent_api_changes_3.3 => api_changes_3.3}/development.rst (100%) rename doc/api/{recent_api_changes_3.3 => api_changes_3.3}/removals.rst (100%) diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst index 73383d103c16..b599d5654d36 100644 --- a/doc/api/api_changes.rst +++ b/doc/api/api_changes.rst @@ -21,12 +21,12 @@ added to Matplotlib, see :ref:`whats-new`. .. note:: The list below is a table of contents of individual files from the - 'recent_api_changes_3.3' folder. + most recent 'api_changes_X.Y' folder. When a release is made - - The files in 'recent_api_changes_3.3/' should be moved to a new file in - 'prev_api_changes/'. + - The files in the most recent 'api_changes_X.Y/' should be moved to a + new file in 'prev_api_changes/'. - The include directive below should be changed to point to the new file created in the previous step. @@ -35,6 +35,6 @@ added to Matplotlib, see :ref:`whats-new`. :glob: :maxdepth: 1 - recent_api_changes_3.3/* + the most recent api_changes_X.Y/* .. include:: prev_api_changes/api_changes_3.2.0.rst diff --git a/doc/api/recent_api_changes_3.3/2019-04-25-AL.rst b/doc/api/api_changes_3.3/2019-04-25-AL.rst similarity index 100% rename from doc/api/recent_api_changes_3.3/2019-04-25-AL.rst rename to doc/api/api_changes_3.3/2019-04-25-AL.rst diff --git a/doc/api/recent_api_changes_3.3/README.rst b/doc/api/api_changes_3.3/README.rst similarity index 87% rename from doc/api/recent_api_changes_3.3/README.rst rename to doc/api/api_changes_3.3/README.rst index 6b65d8a1f558..a8c7538e5618 100644 --- a/doc/api/recent_api_changes_3.3/README.rst +++ b/doc/api/api_changes_3.3/README.rst @@ -3,8 +3,8 @@ Adding API change notes ======================= -API change notes for future releases are collected in the directory -:file:`recent_api_changes_3.3`. They are divided into four categories: +API change notes for future releases are collected in the most recent directory +:file:`api_changes_X.Y`. They are divided into four categories: - **Deprecations**: Announcements of future changes. Typically, these will raise a deprecation warning and users of this API should change their code diff --git a/doc/api/recent_api_changes_3.3/behaviour.rst b/doc/api/api_changes_3.3/behaviour.rst similarity index 100% rename from doc/api/recent_api_changes_3.3/behaviour.rst rename to doc/api/api_changes_3.3/behaviour.rst diff --git a/doc/api/recent_api_changes_3.3/deprecations.rst b/doc/api/api_changes_3.3/deprecations.rst similarity index 100% rename from doc/api/recent_api_changes_3.3/deprecations.rst rename to doc/api/api_changes_3.3/deprecations.rst diff --git a/doc/api/recent_api_changes_3.3/development.rst b/doc/api/api_changes_3.3/development.rst similarity index 100% rename from doc/api/recent_api_changes_3.3/development.rst rename to doc/api/api_changes_3.3/development.rst diff --git a/doc/api/recent_api_changes_3.3/removals.rst b/doc/api/api_changes_3.3/removals.rst similarity index 100% rename from doc/api/recent_api_changes_3.3/removals.rst rename to doc/api/api_changes_3.3/removals.rst diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 3e3cc3d9dfc3..f448c876aac8 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -95,7 +95,8 @@ Documentation :file:`doc/users/whats_new.rst`. * If you change the API in a backward-incompatible way, please - document it in the relevant file in :file:`doc/api/recent_api_changes_3.3`. + document it in the relevant file in most recent + :file:`doc/api/api_changes_X.Y`. .. _pr-labels: @@ -145,8 +146,8 @@ Merging the PR. Ensure that all API changes are documented in the relevant file in - :file:`doc/api/recent_api_changes_3.3` and significant new features have and - entry in :file:`doc/user/whats_new`. + the most recent :file:`doc/api/api_changes_X.Y` 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 reviewer, but not necessarily) may champion that PR for merging. In order diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index edeb1c03446e..07f6195f9b21 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -318,7 +318,7 @@ Changes to the public API must follow a standard deprecation procedure to prevent unexpected breaking of code that uses Matplotlib. - Deprecations must be announced via an entry in - :file:`doc/api/recent_api_changes_3.3`. + the most recent :file:`doc/api/api_changes_X.Y` - Deprecations are targeted at the next point-release (i.e. 3.x.0). - The deprecated API should, to the maximum extent possible, remain fully functional during the deprecation period. In cases where this is not diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index 9590e9c1d20c..35b6cc56bf14 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -112,8 +112,8 @@ For the "what's new", Similarly for the "API changes", 1. copy the current api changes to a file is :file:`doc/api/prev_api_changes` - 2. merge all of the files in :file:`doc/api/recent_api_changes_3.3/` into - :file:`doc//whats_new.rst` + 2. merge all of the files in the most recent :file:`doc/api/api_changes_X.Y` + into :file:`doc//whats_new.rst` 3. comment out the next API changes at the top. In both cases step 3 will have to be un-done right after the release. From be1a3c96866755ed028ed56532a9750f13074193 Mon Sep 17 00:00:00 2001 From: Sidharth Date: Sun, 5 Apr 2020 00:41:04 +0530 Subject: [PATCH 5/9] removed move line --- doc/api/api_changes.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst index b599d5654d36..f7bd71a272fb 100644 --- a/doc/api/api_changes.rst +++ b/doc/api/api_changes.rst @@ -25,8 +25,6 @@ added to Matplotlib, see :ref:`whats-new`. When a release is made - - The files in the most recent 'api_changes_X.Y/' should be moved to a - new file in 'prev_api_changes/'. - The include directive below should be changed to point to the new file created in the previous step. From 91920e4047e69d7f53912b1a678781a5e28b6894 Mon Sep 17 00:00:00 2001 From: Sidharth Date: Sun, 5 Apr 2020 00:48:16 +0530 Subject: [PATCH 6/9] modified the guidelines --- doc/devel/release_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index 35b6cc56bf14..78f3e5c76bcc 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -114,7 +114,7 @@ Similarly for the "API changes", 1. copy the current api changes to a file is :file:`doc/api/prev_api_changes` 2. merge all of the files in the most recent :file:`doc/api/api_changes_X.Y` into :file:`doc//whats_new.rst` - 3. comment out the next API changes at the top. + 3. comment out the most recent API changes at the top. In both cases step 3 will have to be un-done right after the release. From dae433ba104716cace62ccca5c7038e7490e0bcd Mon Sep 17 00:00:00 2001 From: Sidharth Date: Tue, 7 Apr 2020 02:43:58 +0530 Subject: [PATCH 7/9] resolved conflicts --- doc/api/api_changes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst index f7bd71a272fb..63f4e41de716 100644 --- a/doc/api/api_changes.rst +++ b/doc/api/api_changes.rst @@ -21,7 +21,7 @@ added to Matplotlib, see :ref:`whats-new`. .. note:: The list below is a table of contents of individual files from the - most recent 'api_changes_X.Y' folder. + most recent :file:`api_changes_X.Y` folder. When a release is made @@ -33,6 +33,6 @@ added to Matplotlib, see :ref:`whats-new`. :glob: :maxdepth: 1 - the most recent api_changes_X.Y/* + api_changes_3.3/* .. include:: prev_api_changes/api_changes_3.2.0.rst From 1a168eb8ac7dcaa17202540da03b25b159ed9f46 Mon Sep 17 00:00:00 2001 From: Sidharth Bansal <20972099+SidharthBansal@users.noreply.github.com> Date: Tue, 7 Apr 2020 05:10:54 +0530 Subject: [PATCH 8/9] Update doc/devel/coding_guide.rst Co-Authored-By: Elliott Sales de Andrade --- doc/devel/coding_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index f448c876aac8..ffac23812e95 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -147,7 +147,7 @@ Merging Ensure that all API changes are documented in the relevant file in the most recent :file:`doc/api/api_changes_X.Y` and significant new features - have and entry in :file:`doc/user/whats_new`. + have an entry in :file:`doc/user/whats_new`. - If a PR already has a positive review, a core developer (e.g. the first reviewer, but not necessarily) may champion that PR for merging. In order From 3f722001c777a181147935eee0d67803eb5cae1d Mon Sep 17 00:00:00 2001 From: Sidharth Bansal <20972099+SidharthBansal@users.noreply.github.com> Date: Tue, 7 Apr 2020 05:11:15 +0530 Subject: [PATCH 9/9] Update doc/devel/release_guide.rst Co-Authored-By: Elliott Sales de Andrade --- doc/devel/release_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index 78f3e5c76bcc..41ec56dd0a8d 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -113,7 +113,7 @@ Similarly for the "API changes", 1. copy the current api changes to a file is :file:`doc/api/prev_api_changes` 2. merge all of the files in the most recent :file:`doc/api/api_changes_X.Y` - into :file:`doc//whats_new.rst` + into :file:`doc/api/api_changes.rst` 3. comment out the most recent API changes at the top. In both cases step 3 will have to be un-done right after the release.