Skip to content

Mnt rearrange next api again #17265

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.

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
Jul 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [ ] New features are documented, with examples if plot related
- [ ] Documentation is sphinx and numpydoc compliant
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
- [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way
- [ ] Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way

<!--
Thank you so much for your PR! To help us review your contribution, please
Expand Down
5 changes: 4 additions & 1 deletion doc/api/api_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ added to Matplotlib, see :ref:`whats-new`.
:glob:
:maxdepth: 1

api_changes_3.4/*
next_api_changes/behavior/*
next_api_changes/deprecations/*
next_api_changes/development/*
next_api_changes/removals/*

.. include:: prev_api_changes/api_changes_3.3.0.rst
2 changes: 0 additions & 2 deletions doc/api/api_changes_3.4/behaviour.rst

This file was deleted.

2 changes: 0 additions & 2 deletions doc/api/api_changes_3.4/development.rst

This file was deleted.

3 changes: 0 additions & 3 deletions doc/api/api_changes_3.4/removals.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Adding API change notes
=======================

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

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

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

A typical entry could look like this::

Locators
~~~~~~~~
The unused `Locator.autoscale()` method is deprecated (pass the axis
limits to `Locator.view_limits()` instead).
Locators
~~~~~~~~
The unused `Locator.autoscale()` method is deprecated (pass the axis
limits to `Locator.view_limits()` instead).
7 changes: 7 additions & 0 deletions doc/api/next_api_changes/behavior/00001-ABC.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Behavior Change template
~~~~~~~~~~~~~~~~~~~~~~~~

Enter description here....

Please rename file with PR number and your initials i.e. "99999-ABC.rst"
and ``git add`` the new file.
7 changes: 7 additions & 0 deletions doc/api/next_api_changes/deprecations/00001-ABC.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Template for deprecations
~~~~~~~~~~~~~~~~~~~~~~~~~

Add description here...

Please rename file with PR number and your initials i.e. "99999-ABC.rst"
and ``git add`` the new file.
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
Deprecations
------------

``dpi_cor`` property of `.FancyArrowPatch`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This parameter is considered internal and deprecated.


Colorbar docstrings
~~~~~~~~~~~~~~~~~~~
The following globals in :mod:`matplotlib.colorbar` are deprecated:
Expand Down
7 changes: 7 additions & 0 deletions doc/api/next_api_changes/development/00001-ABC.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Development Change template
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Enter description here....

Please rename file with PR number and your initials i.e. "99999-ABC.rst"
and ``git add`` the new file.
7 changes: 7 additions & 0 deletions doc/api/next_api_changes/removals/00001-ABC.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Removal Change template
~~~~~~~~~~~~~~~~~~~~~~~

Enter description of methods/classes removed here....

Please rename file with PR number and your initials i.e. "99999-ABC.rst"
and ``git add`` the new file.
11 changes: 6 additions & 5 deletions doc/devel/coding_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,9 @@ 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 most recent
:file:`doc/api/api_changes_X.Y`.
document it by adding a file in the relevant subdirectory of
:file:`doc/api/next_api_changes/`, probably in the ``behavior/``
subdirectory.

.. _pr-labels:

Expand Down Expand Up @@ -163,9 +164,9 @@ Merging
approve the review and if you think no more review is needed, merge
the PR.

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 an entry in :file:`doc/user/whats_new`.
Ensure that all API changes are documented in a file in one of the
subdirectories of :file:`doc/api/next_api_changes`, and significant new
features 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
Expand Down
12 changes: 8 additions & 4 deletions doc/devel/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,10 @@ 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
:file:`doc/api/api_changes`, by adding to the relevant file
(see :file:`doc/api/api_changes.rst` for more information)
:file:`doc/api/next_api_changes/behavior`, by adding a new file with the
naming convention ``99999-ABC.rst`` where the pull request number is followed
by the contributor's initials. (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 Expand Up @@ -317,8 +319,10 @@ API changes
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
the most recent :file:`doc/api/api_changes_X.Y`
- Deprecations must be announced via a new file in
a new file in :file:`doc/api/next_api_changes/deprecations/` with
naming convention ``99999-ABC.rst`` where ``99999`` is the pull request
number and ``ABC`` are the contributor's initials.
- 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
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/release_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 the most recent :file:`doc/api/api_changes_X.Y`
2. merge all of the files in the most recent :file:`doc/api/next_api_changes`
into :file:`doc/api/api_changes.rst`
3. comment out the most recent API changes at the top.

Expand Down