Skip to content

Commit 821a386

Browse files
committed
DOC: better document the MEP process
1 parent d213621 commit 821a386

File tree

3 files changed

+29
-23
lines changed

3 files changed

+29
-23
lines changed

doc/devel/MEP/README.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:orphan:
2+
3+
4+
################################
5+
Matplotlib Enhancement Proposals
6+
################################
7+
8+
Matplotlib Enhancement Proposals (MEP), inspired by cpython's `PEP's
9+
<https://www.python.org/dev/peps/>`__ but less formal, are design
10+
documents for large or controversial changes to Matplotilb. These
11+
documents should provide a discussion of both why and how the changes
12+
should be made.
13+
14+
To create a new MEP open a pull request (PR) adding a file based on
15+
:ref:`the template <MEP-template>` to this the MEP directory. For the
16+
initial PR only a rough description is required and it should be
17+
merged quickly. Further detailed discussion can happen in follow on
18+
PRs.

doc/devel/MEP/index.rst

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
.. _MEP-index:
22

3-
################################
4-
Matplotlib Enhancement Proposals
5-
################################
3+
.. include:: README.rst
64

75
.. htmlonly::
86

@@ -13,22 +11,9 @@ Matplotlib Enhancement Proposals
1311
:maxdepth: 1
1412

1513
template
16-
MEP08
17-
MEP09
18-
MEP10
19-
MEP11
20-
MEP12
21-
MEP13
22-
MEP14
23-
MEP15
24-
MEP19
25-
MEP21
26-
MEP22
27-
MEP23
28-
MEP24
29-
MEP25
30-
MEP26
31-
MEP27
32-
MEP28
33-
MEP29
3414

15+
.. toctree::
16+
:glob:
17+
:maxdepth: 1
18+
19+
MEP*

doc/devel/MEP/template.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _MEP-template:
2+
13
==============
24
MEP Template
35
==============
@@ -20,14 +22,15 @@ MEPs go through a number of phases in their lifetime:
2022
discussion of the MEP should include the MEP number (MEPxxx) in the
2123
subject line so they can be easily related to the MEP.
2224

23-
- **Progress**: Consensus was reached on the mailing list and
24-
implementation work has begun.
25+
- **Progress**: Consensus was reached and implementation work has begun.
2526

2627
- **Completed**: The implementation has been merged into master.
2728

2829
- **Superseded**: This MEP has been abandoned in favor of another
2930
approach.
3031

32+
- **Rejected**: There are currently no plans to implement the proposal.
33+
3134
Branches and Pull requests
3235
==========================
3336

0 commit comments

Comments
 (0)