Skip to content

Add missing headings to code examples #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 31, 2020
Merged

Add missing headings to code examples #252

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1671f7f
Add missing headings to code examples
Cadair Jan 29, 2020
d4c1517
Update format.rst
Cadair Jan 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion doc/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +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:

.. math:: X(e^{j\omega } ) = x(n)e^{ - j\omega n}
Expand Down Expand Up @@ -419,6 +421,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

Expand Down