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 99eddfc

Browse filesBrowse files
committed
MEP12 - added sphinx-gallery docstrings
1 parent 7d0be18 commit 99eddfc
Copy full SHA for 99eddfc

File tree

Expand file treeCollapse file tree

1 file changed

+16
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+16
-0
lines changed

‎doc/devel/MEP/MEP12.rst

Copy file name to clipboardExpand all lines: doc/devel/MEP/MEP12.rst
+16Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,22 @@ 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 <http://sphinx-gallery.readthedocs.io/>`_: a
91+
title and a description formatted as follows::
92+
93+
"""
94+
===============================
95+
Colormaps alter your perception
96+
===============================
97+
98+
Here I plot the function
99+
100+
.. math:: f(x, y) = \sin(x) + \cos(y)
101+
102+
with different colormaps. Look at how colormaps alter your perception!
103+
"""
104+
105+
90106
* PEP8_ clean-ups (running `flake8
91107
<https://pypi.python.org/pypi/flake8>`_, or a similar checker, is
92108
highly recommended)

0 commit comments

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