Skip to content

Commit 5e9a629

Browse files
authored
Add missing headings to code examples (#252)
* Add missing headings to code examples 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. * Update format.rst
1 parent 4978673 commit 5e9a629

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/format.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,9 @@ The sections of a function's docstring are:
335335
code, possibly including a discussion of the algorithm. This
336336
section may include mathematical equations, written in
337337
`LaTeX <https://www.latex-project.org/>`_ format::
338-
338+
339+
Notes
340+
-----
339341
The FFT is a fast implementation of the discrete Fourier transform:
340342

341343
.. math:: X(e^{j\omega } ) = x(n)e^{ - j\omega n}
@@ -419,6 +421,8 @@ The sections of a function's docstring are:
419421
blank lines. Comments explaining the examples should have blank
420422
lines both above and below them::
421423

424+
Examples
425+
--------
422426
>>> np.add(1, 2)
423427
3
424428

0 commit comments

Comments
 (0)