From 821a386c147b87e1a0eaaf94fa6de4849293f762 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sun, 8 Apr 2018 00:18:10 -0400 Subject: [PATCH 1/2] DOC: better document the MEP process --- doc/devel/MEP/README.rst | 18 ++++++++++++++++++ doc/devel/MEP/index.rst | 27 ++++++--------------------- doc/devel/MEP/template.rst | 7 +++++-- 3 files changed, 29 insertions(+), 23 deletions(-) create mode 100644 doc/devel/MEP/README.rst diff --git a/doc/devel/MEP/README.rst b/doc/devel/MEP/README.rst new file mode 100644 index 000000000000..fe58ee685d91 --- /dev/null +++ b/doc/devel/MEP/README.rst @@ -0,0 +1,18 @@ +:orphan: + + +################################ +Matplotlib Enhancement Proposals +################################ + +Matplotlib Enhancement Proposals (MEP), inspired by cpython's `PEP's +`__ but less formal, are design +documents for large or controversial changes to Matplotilb. These +documents should provide a discussion of both why and how the changes +should be made. + +To create a new MEP open a pull request (PR) adding a file based on +:ref:`the template ` to this the MEP directory. For the +initial PR only a rough description is required and it should be +merged quickly. Further detailed discussion can happen in follow on +PRs. diff --git a/doc/devel/MEP/index.rst b/doc/devel/MEP/index.rst index 9a8d55c7b72a..06c454ad240f 100644 --- a/doc/devel/MEP/index.rst +++ b/doc/devel/MEP/index.rst @@ -1,8 +1,6 @@ .. _MEP-index: -################################ -Matplotlib Enhancement Proposals -################################ +.. include:: README.rst .. htmlonly:: @@ -13,22 +11,9 @@ Matplotlib Enhancement Proposals :maxdepth: 1 template - MEP08 - MEP09 - MEP10 - MEP11 - MEP12 - MEP13 - MEP14 - MEP15 - MEP19 - MEP21 - MEP22 - MEP23 - MEP24 - MEP25 - MEP26 - MEP27 - MEP28 - MEP29 +.. toctree:: + :glob: + :maxdepth: 1 + + MEP* diff --git a/doc/devel/MEP/template.rst b/doc/devel/MEP/template.rst index fae4a5132275..81191fc44eeb 100644 --- a/doc/devel/MEP/template.rst +++ b/doc/devel/MEP/template.rst @@ -1,3 +1,5 @@ +.. _MEP-template: + ============== MEP Template ============== @@ -20,14 +22,15 @@ MEPs go through a number of phases in their lifetime: discussion of the MEP should include the MEP number (MEPxxx) in the subject line so they can be easily related to the MEP. -- **Progress**: Consensus was reached on the mailing list and - implementation work has begun. +- **Progress**: Consensus was reached and implementation work has begun. - **Completed**: The implementation has been merged into master. - **Superseded**: This MEP has been abandoned in favor of another approach. +- **Rejected**: There are currently no plans to implement the proposal. + Branches and Pull requests ========================== From 5e642c9a63e9676a83d3ad698c7bf17767134387 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sun, 8 Apr 2018 00:19:03 -0400 Subject: [PATCH 2/2] DOC: update state of several MEPs --- doc/devel/MEP/MEP08.rst | 4 +++- doc/devel/MEP/MEP09.rst | 1 + doc/devel/MEP/MEP10.rst | 5 +---- doc/devel/MEP/MEP19.rst | 2 +- doc/devel/MEP/MEP26.rst | 2 +- doc/devel/MEP/MEP27.rst | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/devel/MEP/MEP08.rst b/doc/devel/MEP/MEP08.rst index 072a279eacf9..67ce5d3d76ef 100644 --- a/doc/devel/MEP/MEP08.rst +++ b/doc/devel/MEP/MEP08.rst @@ -9,7 +9,9 @@ Status ====== -**Discussion** +**Completed** + +We are currently enforcing a sub-set of pep8 on new code contributions. Branches and Pull requests ========================== diff --git a/doc/devel/MEP/MEP09.rst b/doc/devel/MEP/MEP09.rst index b7e0ca7a39b7..51ac47ca2c79 100644 --- a/doc/devel/MEP/MEP09.rst +++ b/doc/devel/MEP/MEP09.rst @@ -11,6 +11,7 @@ by the user. Status ====== + **Discussion** Branches and Pull requests diff --git a/doc/devel/MEP/MEP10.rst b/doc/devel/MEP/MEP10.rst index dc00e0fb9c0b..634fb44d7235 100644 --- a/doc/devel/MEP/MEP10.rst +++ b/doc/devel/MEP/MEP10.rst @@ -9,14 +9,11 @@ Status **Progress** -Targeted for 1.3 +This is still an on-going effort Branches and Pull requests ========================== -#1665 -#1757 -#1795 Abstract ======== diff --git a/doc/devel/MEP/MEP19.rst b/doc/devel/MEP/MEP19.rst index 9dc995953c80..a39911102052 100644 --- a/doc/devel/MEP/MEP19.rst +++ b/doc/devel/MEP/MEP19.rst @@ -5,7 +5,7 @@ Status ====== -**Discussion** +**Completed** Branches and Pull requests ========================== diff --git a/doc/devel/MEP/MEP26.rst b/doc/devel/MEP/MEP26.rst index 705b65de3014..d49c6f39aa6b 100644 --- a/doc/devel/MEP/MEP26.rst +++ b/doc/devel/MEP/MEP26.rst @@ -9,7 +9,7 @@ Status ====== -**Proposed** +**Rejected** Branches and Pull requests ========================== diff --git a/doc/devel/MEP/MEP27.rst b/doc/devel/MEP/MEP27.rst index 63592cf475a3..13ed37cb73cb 100644 --- a/doc/devel/MEP/MEP27.rst +++ b/doc/devel/MEP/MEP27.rst @@ -8,7 +8,7 @@ Status ====== -**Discussion** +**Progress** Branches and Pull requests ==========================