Skip to content

Change the way API changes are documented #15158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2019
Merged

Change the way API changes are documented #15158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/api_changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ 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
- The files in 'next_api_changes/' 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.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/next_api_changes/behaviour.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Behaviour changes
-----------------
2 changes: 2 additions & 0 deletions doc/api/next_api_changes/deprecations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Deprecations
------------
2 changes: 2 additions & 0 deletions doc/api/next_api_changes/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Development changes
-------------------
2 changes: 2 additions & 0 deletions doc/api/next_api_changes/removals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Removals
--------
6 changes: 3 additions & 3 deletions doc/devel/coding_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
====================
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.rst` for more information)

* See below for additional points about :ref:`keyword-argument-processing`, if
applicable for your pull request.
Expand Down