summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2019-11-19 11:06:39 -0800
committerEric Larson <larson.eric.d@gmail.com>2019-11-19 14:06:38 -0500
commitd5323aeec5b98d2594805a9d3add6e1613d18a60 (patch)
tree5a1a14a0ded9b4f1e5458eb7bd21df0efee8df37
parented7f72df788b4e9db36d95ab20a759110a9c06a4 (diff)
downloadnumpydoc-d5323aeec5b98d2594805a9d3add6e1613d18a60.tar.gz
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.
-rw-r--r--doc/format.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/format.rst b/doc/format.rst
index 9d92569..070bf98 100644
--- a/doc/format.rst
+++ b/doc/format.rst
@@ -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**
@@ -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
@@ -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,