Skip to content

Commit d5323ae

Browse files
rossbarlarsoner
authored andcommitted
DOC: Fixed three formatting issues in docs (#245)
* Fixed line indentation in ''Warns'' section of format.rst * Fixed formatting of RST link in format.rst: Added escape chars to mpl plot directive to get the link to render correctly in the html. * Fixed reference to np.c_ in format.rst.
1 parent ed7f72d commit d5323ae

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/format.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -283,8 +283,8 @@ The sections of a function's docstring are:
283283

284284
10. **Warns**
285285

286-
An optional section detailing which warnings get raised and
287-
under what conditions, formatted similarly to Raises.
286+
An optional section detailing which warnings get raised and
287+
under what conditions, formatted similarly to Raises.
288288

289289
11. **Warnings**
290290

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

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

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

0 commit comments

Comments
 (0)