Skip to content

DOC: Fixed three formatting issues in docs #245

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 1 commit into from
Nov 19, 2019
Merged

DOC: Fixed three formatting issues in docs #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions doc/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,8 +283,8 @@ The sections of a function's docstring are:

10. **Warns**

An optional section detailing which warnings get raised and
under what conditions, formatted similarly to Raises.
An optional section detailing which warnings get raised and
under what conditions, formatted similarly to Raises.

11. **Warnings**

Expand Down Expand Up @@ -472,7 +472,7 @@ The sections of a function's docstring are:
demonstrated function, must be explicit.

When matplotlib is imported in the example, the Example code will be
wrapped in `matplotlib's Sphinx `plot` directive
wrapped in `matplotlib's Sphinx \`plot\` directive
<http://matplotlib.org/sampledoc/extensions.html>`_. When matplotlib is
not explicitly imported, `.. plot::` can be used directly if
`matplotlib.sphinxext.plot_directive` is loaded as a Sphinx extension in
Expand Down Expand Up @@ -560,7 +560,7 @@ as appropriate.
Documenting class instances
---------------------------
Instances of classes that are part of the NumPy API (for example `np.r_`
`np,c_`, `np.index_exp`, etc.) may require some care. To give these
`np.c_`, `np.index_exp`, etc.) may require some care. To give these
instances a useful docstring, we do the following:

* Single instance: If only a single instance of a class is exposed,
Expand Down