summaryrefslogtreecommitdiff
path: root/doc/validation.rst
diff options
context:
space:
mode:
authorJoel Nothman <joel.nothman@gmail.com>2018-03-28 23:45:13 +1100
committerJoel Nothman <joel.nothman@gmail.com>2018-03-28 23:45:13 +1100
commit6d5d44930358a31a538bc067129ccbe2b2387107 (patch)
tree73e21b37122b9e1061ae839152b71a076b69769f /doc/validation.rst
parent65cd2866c4000f399c48d8215229930210457578 (diff)
downloadnumpydoc-6d5d44930358a31a538bc067129ccbe2b2387107.tar.gz
Add documentation
Diffstat (limited to 'doc/validation.rst')
-rw-r--r--doc/validation.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/validation.rst b/doc/validation.rst
new file mode 100644
index 0000000..c851668
--- /dev/null
+++ b/doc/validation.rst
@@ -0,0 +1,12 @@
+==============================
+Validating NumpyDoc docstrings
+==============================
+
+One tool for validating docstrings is to see how an object's dosctring
+translates to Restructured Text. Using numpydoc as a command-line tool
+facilitates this. For example to see the Restructured Text generated
+for ``numpy.ndarray``, use:
+
+.. code-block:: bash
+
+ $ python -m numpydoc numpy.ndarray