summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorendolith <endolith@gmail.com>2016-05-11 18:51:39 -0400
committerEndolith <endolith@gmail.com>2016-05-11 20:41:06 -0400
commit2df36ec6bf0beb0258898003a182b03590bee0c1 (patch)
tree42bce19c4809eaf638bfe9719e814d53974d08c2 /doc
parenta7e9f4579fa14a3b72af6e723bcbe5549cd6f1c1 (diff)
downloadnumpy-2df36ec6bf0beb0258898003a182b03590bee0c1.tar.gz
DOC: Clarify definition list format in HOWTO
Definition lists are marked up with indentation, not colons, and extra colons break the web formatting
Diffstat (limited to 'doc')
-rw-r--r--doc/HOWTO_DOCUMENT.rst.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt
index 9976da1e0..954f331e8 100644
--- a/doc/HOWTO_DOCUMENT.rst.txt
+++ b/doc/HOWTO_DOCUMENT.rst.txt
@@ -178,6 +178,8 @@ The sections of the docstring are:
----------
x : type
Description of parameter `x`.
+ y
+ Description of parameter `y` (with type not specified)
Enclose variables in single backticks. The colon must be preceded
by a space, or omitted if the type is absent.