8000 File name made more understandable by SidharthBansal · Pull Request #17021 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

File name made more understandable #17021

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
6 changes: 3 additions & 3 deletions doc/api/api_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ added to Matplotlib, see :ref:`whats-new`.
.. note::

The list below is a table of contents of individual files from the
'next_api_changes' folder.
'recent_api_changes_3.3' folder.

When a release is made

- The files in 'next_api_changes/' should be moved to a new file in
- The files in 'recent_api_changes_3.3/' 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 All @@ -35,6 +35,6 @@ added to Matplotlib, see :ref:`whats-new`.
:glob:
:maxdepth: 1

next_api_changes/*
recent_api_changes_3.3/*

.. include:: prev_api_changes/api_changes_3.2.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Adding API change notes
=======================

API change notes for future releases are collected in the directory
:file:`next_api_changes`. They are divided into four categories:
:file:`recent_api_changes_3.3`. They are divided into four categories:

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

4 changes: 2 additions & 2 deletions doc/devel/coding_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ 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 :file:`doc/api/next_api_changes`.
document it in the relevant file in :file:`doc/api/recent_api_changes_3.3`.

.. _pr-labels:

Expand Down Expand Up @@ -145,7 +145,7 @@ Merging
the PR.

Ensure that all API changes are documented in the relevant file in
:file:`doc/api/next_api_changes` and significant new features have and
:file:`doc/api/recent_api_changes_3.3` 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
2 changes: 1 addition & 1 deletion doc/devel/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ 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
:file:`doc/api/next_api_changes`.
:file:`doc/api/recent_api_changes_3.3`.
- 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 :file:`doc/api/next_api_changes/` into
2. merge all of the files in :file:`doc/api/recent_api_changes_3.3/` into
:file:`doc//whats_new.rst`
3. comment out the next API changes at the top.

Expand Down
0