Skip to content

Commit

Permalink
DOC: Clarify documentation for Yields.
Browse files Browse the repository at this point in the history
  • Loading branch information
chebee7i committed Jan 11, 2015
1 parent 3d182f0 commit 4eac56a
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions doc/HOWTO_DOCUMENT.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4eac56a

Please sign in to comment.