summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorchebee7i <chebee7i@gmail.com>2015-01-11 15:32:52 -0600
committerchebee7i <chebee7i@gmail.com>2015-01-11 15:36:12 -0600
commit4eac56a72907c54038a4863186af8e2198653125 (patch)
tree124253413ffd0f009ad6e65a14119457a5366d8f /doc
parent3d182f03fd6956aa464f610f6d1e4a3d214a946a (diff)
downloadnumpy-4eac56a72907c54038a4863186af8e2198653125.tar.gz
DOC: Clarify documentation for Yields.
Diffstat (limited to 'doc')
-rw-r--r--doc/HOWTO_DOCUMENT.rst.txt7
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt
index 00567f98f..228994743 100644
--- a/doc/HOWTO_DOCUMENT.rst.txt
+++ b/doc/HOWTO_DOCUMENT.rst.txt
@@ -249,16 +249,15 @@ The sections of the docstring are:
6. **Yields**
Explanation of the yielded values and their types. This is relevant to
- generators only. Similar to the **Parameters** section, except the name
- of each return value is optional. The type of each return value is
- always required::
+ generators only. Similar to the **Returns** section in that the name of
+ each value is optional, but the type of each value is always required::
Yields
------
int
Description of the anonymous integer return value.
- If both the name and type are specified, the **Returns** section takes the
+ If both the name and type are specified, the **Yields** section takes the
same form as the **Parameters** section::
Yields