Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MEP12 - added sphinx-gallery docstrings #7277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 17, 2016
Merged

MEP12 - added sphinx-gallery docstrings #7277

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99eddfc
MEP12 - added sphinx-gallery docstrings
NelleV Oct 16, 2016
3a21610
DOC MEP12 fixes reviewers' comments
NelleV Oct 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions doc/devel/MEP/MEP12.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://sphinx-gallery.readthedocs.io/>`_: 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
<https://pypi.python.org/pypi/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
<https://github.com/tonysyu/matplotlib/commit/6d1b8a2ef277091eb718690e4443e6fa30cbc488>`_.
* Replace uses of ``pylab`` interface with ``pyplot`` (+ ``numpy``,
etc.). See `c25ef1e
<https://github.com/tonysyu/matplotlib/commit/c25ef1e02b3a0ecb279492409dac0de9b3d2c0e2>`_
Expand Down