Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit b9ba7ea

Browse filesBrowse files
authored
Merge pull request #7277 from NelleV/MEP12
MEP12 - added sphinx-gallery docstrings
2 parents 2a4ce9a + 3a21610 commit b9ba7ea
Copy full SHA for b9ba7ea

File tree

Expand file treeCollapse file tree

1 file changed

+17
-3
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+17
-3
lines changed

‎doc/devel/MEP/MEP12.rst

Copy file name to clipboardExpand all lines: doc/devel/MEP/MEP12.rst
+17-3Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,27 @@ the gallery would remain in those directories until they are cleaned
8787
up. After clean-up, they would be moved to one of the new gallery
8888
sections described above. "Clean-up" should involve:
8989

90+
* `sphinx-gallery docstrings <https://sphinx-gallery.readthedocs.io/>`_: a
91+
title and a description of the example formatted as follows, at the top of
92+
the example::
93+
94+
"""
95+
===============================
96+
Colormaps alter your perception
97+
===============================
98+
99+
Here I plot the function
100+
101+
.. math:: f(x, y) = \sin(x) + \cos(y)
102+
103+
with different colormaps. Look at how colormaps alter your perception!
104+
"""
105+
106+
90107
* PEP8_ clean-ups (running `flake8
91108
<https://pypi.python.org/pypi/flake8>`_, or a similar checker, is
92109
highly recommended)
93110
* Commented-out code should be removed.
94-
* Add introductory sentence or paragraph in the main docstring. See
95-
`6d1b8a2
96-
<https://github.com/tonysyu/matplotlib/commit/6d1b8a2ef277091eb718690e4443e6fa30cbc488>`_.
97111
* Replace uses of ``pylab`` interface with ``pyplot`` (+ ``numpy``,
98112
etc.). See `c25ef1e
99113
<https://github.com/tonysyu/matplotlib/commit/c25ef1e02b3a0ecb279492409dac0de9b3d2c0e2>`_

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.