8000 Merge pull request #17265 from jklymak/mnt-rearrange-next-api-again · matplotlib/matplotlib@9f78b84 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9f78b84

Browse files
QuLogicQuLogic
authored
Merge pull request #17265 from jklymak/mnt-rearrange-next-api-again
Mnt rearrange next api again
2 parents 6a66f76 + 7c06fcb commit 9f78b84

File tree

14 files changed

+59
-33
lines changed

14 files changed

+59
-33
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- [ ] New features are documented, with examples if plot related
88
- [ ] Documentation is sphinx and numpydoc compliant
99
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
10-
- [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way
10+
- [ ] Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way
1111

1212
<!--
1313
Thank you so much for your PR! To help us review your contribution, please

‎doc/api/api_changes.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ added to Matplotlib, see :ref:`whats-new`.
3333
:glob:
3434
:maxdepth: 1
3535

36-
api_changes_3.4/*
36+
next_api_changes/behavior/*
37+
next_api_changes/deprecations/*
38+
next_api_changes/development/*
39+
next_api_changes/removals/*
3740

3841
.. include:: prev_api_changes/api_changes_3.3.0.rst

‎doc/api/api_changes_3.4/behaviour.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎doc/api/api_changes_3.4/development.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎doc/api/api_changes_3.4/removals.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

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

Lines changed: 11 additions & 10 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 most recent directory
7-
:file:`api_changes_X.Y`. They are divided into four categories:
6+
API change notes for future releases are collected in
7+
:file:`next_api_changes`. They are divided into four subdirectories:
88

99
- **Deprecations**: Announcements of future changes. Typically, these will
1010
raise a deprecation warning and users of this API should change their code
@@ -16,14 +16,15 @@ API change notes for future releases are collected in the most recent directory
1616
result.
1717
- **Development changes**: Changes to the build process, dependencies, etc.
1818

19-
Please place new entries in the respective files in this directory. Typically,
20-
each change will get its own section, but you may also amend existing sections
21-
when suitable. The overall goal is a comprehensible documentation of the
22-
changes.
19+
Please place new entries in these directories with a new file named
20+
``99999-ABC.rst``, where ``99999`` would be the PR number, and ``ABC`` the
21+
author's initials. Typically, each change will get its own file, but you may
22+
also amend existing files when suitable. The overall goal is a comprehensible
23+
documentation of the changes.
2324

2425
A typical entry could look like this::
2526

26-
Locators
27-
~~~~~~~~
28-
The unused `Locator.autoscale()` method is deprecated (pass the axis
29-
limits to `Locator.view_limits()` instead).
27+
Locators
28+
~~~~~~~~
29+
The unused `Locator.autoscale()` method is deprecated (pass the axis
30+
limits to `Locator.view_limits()` instead).

‎doc/api/next_api_changes/behavior/00001-ABC.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Behavior Change template
2+
~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
Enter description here....
5+
6+
Please rename file with PR number and your initials i.e. "99999-ABC.rst"
7+
and ``git add`` the new file.

‎doc/api/next_api_changes/deprecations/00001-ABC.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Template for deprecations
2+
~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
Add description here...
5+
6+
Please rename file with PR number and your initials i.e. "99999-ABC.rst"
7+
and ``git add`` the new file.

‎doc/api/api_changes_3.4/deprecations.rst renamed to ‎doc/api/next_api_changes/deprecations/00009-AL.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
Deprecations
2-
------------
3-
41
``dpi_cor`` property of `.FancyArrowPatch`
52
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63
This parameter is considered internal and deprecated.
74

8-
95
Colorbar docstrings
106
~~~~~~~~~~~~~~~~~~~
117
The following globals in :mod:`matplotlib.colorbar` are deprecated:

‎doc/api/next_api_changes/development/00001-ABC.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Development Change template
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
Enter description here....
5+
6+
Please rename file with PR number and your initials i.e. "99999-ABC.rst"
7+
and ``git add`` the new file.

‎doc/api/next_api_changes/removals/00001-ABC.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Removal Change template
2+
~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
Enter description of methods/classes removed here....
5+
6+
Please rename file with PR number and your initials i.e. "99999-ABC.rst"
7+
and ``git add`` the new file.

‎doc/devel/coding_guide.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,9 @@ Documentation
110110
:file:`doc/users/whats_new.rst`.
111111

112112
* If you change the API in a backward-incompatible way, please
113-
document it in the relevant file in most recent
114-
:file:`doc/api/api_changes_X.Y`.
113+
document it by adding a file in the relevant subdirectory of
114+
:file:`doc/api/next_api_changes/`, probably in the ``behavior/``
115+
subdirectory.
115116

116117
.. _pr-labels:
117118

@@ -163,9 +164,9 @@ Merging
163164
approve the review and if you think no more review is needed, merge
164165
the PR.
165166

166-
Ensure that all API changes are documented in the relevant file in
167-
the most recent :file:`doc/api/api_changes_X.Y` and significant new features
168-
have an entry in :file:`doc/user/whats_new`.
167+
Ensure that all API changes are documented in a file in one of the
168+
subdirectories of :file:`doc/api/next_api_changes`, and significant new
169+
features have an entry in :file:`doc/user/whats_new`.
169170

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

‎doc/devel/contributing.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,10 @@ rules before submitting a pull request:
227227
:file:`doc/users/next_whats_new/README.rst` for more information).
228228

229229
* If you change the API in a backward-incompatible way, please document it in
230-
:file:`doc/api/api_changes`, by adding to the relevant file
231-
(see :file:`doc/api/api_changes.rst` for more information)
230+
:file:`doc/api/next_api_changes/behavior`, by adding a new file with the
231+
naming convention ``99999-ABC.rst`` where the pull request number is followed
232+
by the contributor's initials. (see :file:`doc/api/api_changes.rst` for more
233+
information)
232234

233235
* See below for additional points about :ref:`keyword-argument-processing`, if
234236
applicable for your pull request.
@@ -317,8 +319,10 @@ API changes
317319
Changes to the public API must follow a standard deprecation procedure to
318320
prevent unexpected breaking of code that uses Matplotlib.
319321

320-
- Deprecations must be announced via an entry in
321-
the most recent :file:`doc/api/api_changes_X.Y`
322+
- Deprecations must be announced via a new file in
323+
a new file in :file:`doc/api/next_api_changes/deprecations/` with
324+
naming convention ``99999-ABC.rst`` where ``99999`` is the pull request
325+
number and ``ABC`` are the contributor's initials.
322326
- Deprecations are targeted at the next point-release (i.e. 3.x.0).
323327
- The deprecated 933D API should, to the maximum extent possible, remain fully
324328
functional during the deprecation period. In cases where this is not

‎doc/devel/release_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ 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 the most recent :file:`doc/api/api_changes_X.Y`
115+
2. merge all of the files in the most recent :file:`doc/api/next_api_changes`
116116
into :file:`doc/api/api_changes.rst`
117117
3. comment out the most recent API changes at the top.
118118

0 commit comments

Comments
 (0)
0