README.rst
1:orphan:
2
3Adding API change notes
4=======================
5
6API change notes for future releases are collected in
7:file:`next_api_changes`. They are divided into four subdirectories:
8
9- **Deprecations**: Announcements of future changes. Typically, these will
10 raise a deprecation warning and users of this API should change their code
11 to stay compatible with future releases of Matplotlib. If possible, state
12 what should be used instead.
13- **Removals**: Parts of the API that got removed. If possible, state what
14 should be used instead.
15- **Behaviour changes**: API that stays valid but will yield a different
16 result.
17- **Development changes**: Changes to the build process, dependencies, etc.
18
19Please 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
21author's initials. Typically, each change will get its own file, but you may
22also amend existing files when suitable. The overall goal is a comprehensible
23documentation of the changes.
24
25Please avoid using references in section titles, as it causes links to be
26confusing in the table of contents. Instead, ensure that a reference is
27included in the descriptive text. A typical entry could look like this::
28
29 Locators
30 ~~~~~~~~
31 The unused `Locator.autoscale()` method is deprecated (pass the axis
32 limits to `Locator.view_limits()` instead).
33