diff options
| author | Ralf Gommers <ralf.gommers@googlemail.com> | 2011-09-27 21:59:22 +0200 |
|---|---|---|
| committer | Ralf Gommers <ralf.gommers@googlemail.com> | 2011-09-27 21:59:22 +0200 |
| commit | fac867419eccdc48aebccdec9216eba52d1676e1 (patch) | |
| tree | 3736371971f7be415a67112c822167d5a06210e7 /doc/HOWTO_DOCUMENT.rst.txt | |
| parent | aded70c4d02eec7a347af9868f1691dc49310f4d (diff) | |
| download | numpy-fac867419eccdc48aebccdec9216eba52d1676e1.tar.gz | |
DOC: add note on formatting math to HOWTO_DOCUMENT.
Diffstat (limited to 'doc/HOWTO_DOCUMENT.rst.txt')
| -rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index ee083c4fe..6ca5dd0f8 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -526,6 +526,17 @@ belong in docstrings. Other points to keep in mind ---------------------------- +* Equations : as discussed in the Notes section above, LaTeX formatting should + be kept to a minimum. Often it's possible to show equations as Python code + or pseudo-code instead, which is much better readable in a terminal. For + inline display use double backticks (like ``y = np.sin(x)``). For display + with blank lines above and below, use a double colon and indent the code, + like:: + + end of previous sentence:: + + y = np.sin(x) + * Notes and Warnings : If there are points in the docstring that deserve special emphasis, the reST directives for a note or warning can be used in the vicinity of the context of the warning (inside a section). Syntax: |