Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b85c7f4

Browse files
timhoffmtimhoffm
authored
Merge pull request #17021 from SidharthBansal/file_name_made_more_understandable
File name made more understandable
2 parents 348e9fe + 3f72200 commit b85c7f4

10 files changed

+12
-14
lines changed

‎doc/api/api_changes.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,10 @@ added to Matplotlib, see :ref:`whats-new`.
2121
.. note::
2222

2323
The list below is a table of contents of individual files from the
24-
'next_api_changes' folder.
24+
most recent :file:`api_changes_X.Y` folder.
2525

2626
When a release is made
2727

28-
- The files in 'next_api_changes/' should be moved to a new file in
29-
'prev_api_changes/'.
3028
- The include directive below should be changed to point to the new file
3129
created in the previous step.
3230

@@ -35,6 +33,6 @@ added to Matplotlib, see :ref:`whats-new`.
3533
:glob:
3634
:maxdepth: 1
3735

38-
next_api_changes/*
36+
api_changes_3.3/*
3937

4038
.. include:: prev_api_changes/api_changes_3.2.0.rst

‎doc/api/next_api_changes/2019-04-25-AL.rst renamed to ‎doc/api/api_changes_3.3/2019-04-25-AL.rst

File renamed without changes.

‎doc/api/next_api_changes/README.rst renamed to ‎doc/api/api_changes_3.3/README.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Adding API change notes
44
=======================
55

6-
API change notes for future releases are collected in the directory
7-
:file:`next_api_changes`. They are divided into four categories:
6+
API change notes for future releases are collected in the most recent directory
7+
:file:`api_changes_X.Y`. They are divided into four categories:
88

99
- **Deprecations**: Announcements of future changes. Typically, these will
1010
raise a deprecation warning and users of this API should change their code
@@ -27,4 +27,3 @@ A typical entry could look like this::
2727
~~~~~~~~
2828
The unused `Locator.autoscale()` method is deprecated (pass the axis
2929
limits to `Locator.view_limits()` instead).
30-

‎doc/api/next_api_changes/behaviour.rst renamed to ‎doc/api/api_changes_3.3/behaviour.rst

File renamed without changes.

‎doc/api/next_api_changes/deprecations.rst renamed to ‎doc/api/api_changes_3.3/deprecations.rst

File renamed without changes.

‎doc/api/next_api_changes/development.rst renamed to ‎doc/api/api_changes_3.3/development.rst

File renamed without changes.

‎doc/api/next_api_changes/removals.rst renamed to ‎doc/api/api_changes_3.3/removals.rst

File renamed without changes.

‎doc/devel/coding_guide.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ Documentation
9595
:file:`doc/users/whats_new.rst`.
9696

9797
* If you change the API in a backward-incompatible way, please
98-
document it in the relevant file in :file:`doc/api/next_api_changes`.
98+
document it in the relevant file in most recent
99+
:file:`doc/api/api_changes_X.Y`.
99100

100101
.. _pr-labels:
101102

@@ -145,8 +146,8 @@ Merging
145146
the PR.
146147

147148
Ensure that all API changes are documented in the relevant file in
148-
:file:`doc/api/next_api_changes` and significant new features have and
149-
entry in :file:`doc/user/whats_new`.
149+
the most recent :file:`doc/api/api_changes_X.Y` and significant new features
150+
have an entry in :file:`doc/user/whats_new`.
150151

151152
- If a PR already has a positive review, a core developer (e.g. the first
152153
reviewer, but not necessarily) may champion that PR for merging. In order

‎doc/devel/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ Changes to the public API must follow a standard deprecation procedure to
318318
prevent unexpected breaking of code that uses Matplotlib.
319319

320320
- Deprecations must be announced via an entry in
321-
:file:`doc/api/next_api_changes`.
321+
the most recent :file:`doc/api/api_changes_X.Y`
322322
- Deprecations are targeted at the next point-release (i.e. 3.x.0).
323323
- The deprecated API should, to the maximum extent possible, remain fully
324324
functional during the deprecation period. In cases where this is not

‎doc/devel/release_guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ For the "what's new",
112112
Similarly for the "API changes",
113113

114114
1. copy the current api changes to a file is :file:`doc/api/prev_api_changes`
115-
2. merge all of the files in :file:`doc/api/next_api_changes/` into
116-
:file:`doc//whats_new.rst`
117-
3. comment out the next API changes at the top.
115+
2. merge all of the files in the most recent :file:`doc/api/api_changes_X.Y`
116+
into :file:`doc/api/api_changes.rst`
117+
3. comment out the most recent API changes at the top.
118118

119119
In both cases step 3 will have to be un-done right after the release.
120120

0 commit comments

Comments
 (0)