From 99eddfcb3306603701fc8be028036a8626a6c8a7 Mon Sep 17 00:00:00 2001 From: Nelle Varoquaux Date: Sat, 15 Oct 2016 18:23:24 -0700 Subject: [PATCH 1/2] MEP12 - added sphinx-gallery docstrings --- doc/devel/MEP/MEP12.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/devel/MEP/MEP12.rst b/doc/devel/MEP/MEP12.rst index d66929cd9d8c..e4de5b72a09c 100644 --- a/doc/devel/MEP/MEP12.rst +++ b/doc/devel/MEP/MEP12.rst @@ -87,6 +87,22 @@ 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 formatted as follows:: + + """ + =============================== + 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) From 3a216106d82d2177ef04c36658a30c22a724e176 Mon Sep 17 00:00:00 2001 From: Nelle Varoquaux Date: Sun, 16 Oct 2016 11:48:32 -0700 Subject: [PATCH 2/2] DOC MEP12 fixes reviewers' comments --- doc/devel/MEP/MEP12.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/devel/MEP/MEP12.rst b/doc/devel/MEP/MEP12.rst index e4de5b72a09c..573083ada5c3 100644 --- a/doc/devel/MEP/MEP12.rst +++ b/doc/devel/MEP/MEP12.rst @@ -87,8 +87,9 @@ 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 formatted as follows:: +* `sphinx-gallery docstrings `_: a + title and a description of the example formatted as follows, at the top of + the example:: """ =============================== @@ -107,9 +108,6 @@ sections described above. "Clean-up" should involve: `_, 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 `_