diff options
| author | Stuart Mumford <stuart@cadair.com> | 2020-01-29 18:11:48 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-29 18:11:48 +0000 |
| commit | 1671f7f23bce77e01e20899513a81252c24495be (patch) | |
| tree | a0dd7680dce389852890fde3bf60009d84fe3766 | |
| parent | 4978673c5fb9902da0ced8208c4742409c080674 (diff) | |
| download | numpydoc-itten-in-latex.tar.gz | |
Add missing headings to code examplesitten-in-latex
The Notes and Examples sections have code examples showing what can go in the section, and unlike all the other sections with examples didn't show the heading.
| -rw-r--r-- | doc/format.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/format.rst b/doc/format.rst index 070bf98..d7971ce 100644 --- a/doc/format.rst +++ b/doc/format.rst @@ -335,6 +335,9 @@ The sections of a function's docstring are: code, possibly including a discussion of the algorithm. This section may include mathematical equations, written in `LaTeX <https://www.latex-project.org/>`_ format:: + + Notes + ----- The FFT is a fast implementation of the discrete Fourier transform: @@ -419,6 +422,8 @@ The sections of a function's docstring are: blank lines. Comments explaining the examples should have blank lines both above and below them:: + Examples + -------- >>> np.add(1, 2) 3 |