diff --git a/doc/devel/MEP/MEP12.rst b/doc/devel/MEP/MEP12.rst index d66929cd9d8c..573083ada5c3 100644 --- a/doc/devel/MEP/MEP12.rst +++ b/doc/devel/MEP/MEP12.rst @@ -87,13 +87,27 @@ the gallery would remain in those directories until they are cleaned up. After clean-up, they would be moved to one of the new gallery sections described above. "Clean-up" should involve: +* `sphinx-gallery docstrings `_: a + title and a description of the example formatted as follows, at the top of + the example:: + + """ + =============================== + Colormaps alter your perception + =============================== + + Here I plot the function + + .. math:: f(x, y) = \sin(x) + \cos(y) + + with different colormaps. Look at how colormaps alter your perception! + """ + + * PEP8_ clean-ups (running `flake8 `_, or a similar checker, is highly recommended) * Commented-out code should be removed. -* Add introductory sentence or paragraph in the main docstring. See - `6d1b8a2 - `_. * Replace uses of ``pylab`` interface with ``pyplot`` (+ ``numpy``, etc.). See `c25ef1e `_