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

Skip to content

Commit f05d4d4

Browse files
jklymakjklymak
committed
doc
1 parent 3164f34 commit f05d4d4

8 files changed

Lines changed: 13 additions & 9 deletions

File tree

‎.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/next_api_changes/behaviour.rst/2020-01-01-AL.rst renamed to doc/api/next_api_changes/behaviour/2020-01-01-AL.rst

File renamed without changes.

doc/api/next_api_changes/deprecations.rst/2020-01-01-AL.rst renamed to doc/api/next_api_changes/deprecations/2020-01-01-AL.rst

File renamed without changes.

doc/api/next_api_changes/development.rst/2020-01-01-AL.rst renamed to doc/api/next_api_changes/development/2020-01-01-AL.rst

File renamed without changes.

doc/api/next_api_changes/removals.rst/2020-01-01-AL.rst renamed to doc/api/next_api_changes/removals/2020-01-01-AL.rst

File renamed without changes.

‎doc/devel/coding_guide.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ Documentation
111111

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

116117
.. _pr-labels:
117118

@@ -164,8 +165,8 @@ Merging
164165
the PR.
165166

166167
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`.
168+
the most recent :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: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,9 @@ 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/behaviour`, by adding a new file with the
231+
naming convention ``20202-02-17-JMK.rst`` where the date is followed by the
232+
contributor's initials.
232233

233234
* See below for additional points about :ref:`keyword-argument-processing`, if
234235
applicable for your pull request.
@@ -317,8 +318,10 @@ API changes
317318
Changes to the public API must follow a standard deprecation procedure to
318319
prevent unexpected breaking of code that uses Matplotlib.
319320

320-
- Deprecations must be announced via an entry in
321-
the most recent :file:`doc/api/api_changes_X.Y`
321+
- Deprecations must be announced via a new file in
322+
the most recent :file:`doc/api/next_api_changes/deprecations/` with
323+
naming convention ``2020-01-01-JMK.rst`` where ``JMK`` are the contributor's
324+
initials.
322325
- Deprecations are targeted at the next point-release (i.e. 3.x.0).
323326
- The deprecated API should, to the maximum extent possible, remain fully
324327
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)