8000 Update contributing.rst · matplotlib/matplotlib@3a134aa · GitHub
[go: up one dir, main page]

Skip to content

Commit 3a134aa

Browse files
author
Sven Eschlbeck
authored
Update contributing.rst
Introduced more specific subsection titles since it is obvious that all refer to Deprecations
1 parent 88fadaa commit 3a134aa

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/devel/contributing.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -293,10 +293,8 @@ All API changes in Matplotlib have to be performed following the below
293293
deprecation process. This ensures that users are notified before the change
294294
will take effect and thus prevents unexpected breaking of code.
295295

296-
Deprecation process
297-
~~~~~~~~~~~~~~~~~~~
298-
299-
Rules:
296+
Rules
297+
~~~~~
300298

301299
- Deprecations are targeted at the next point.release (e.g. 3.x)
302300
- Deprecated API is generally removed two two point-releases after introduction
@@ -308,7 +306,8 @@ Rules:
308306
- If in doubt, decisions about API changes are finally made by the
309307
API consistency lead developer
310308

311-
Introducing a deprecation:
309+
Introducing
310+
~~~~~~~~~~~
312311

313312
1. Announce the deprecation in a new file
314313
:file:`doc/api/next_api_changes/deprecations/99999-ABC.rst` where ``99999``
@@ -326,7 +325,8 @@ Introducing a deprecation:
326325
All these helpers take a first parameter *since*, which should be set to
327326
the next point release, e.g. "3.x".
328327

329-
Expiring a deprecation:
328+
Expiring
329+
~~~~~~~~
330330

331331
1. Announce the API changes in a new file
332332
:file:`doc/api/next_api_changes/[kind]/99999-ABC.rst` where ``99999``

0 commit comments

Comments
 (0)
0