diff options
author | Rob Ruana <rob@relentlessidiot.com> | 2013-06-25 01:29:56 -0400 |
---|---|---|
committer | Rob Ruana <rob@relentlessidiot.com> | 2013-06-25 01:29:56 -0400 |
commit | 2241e6c363da15403a45640382ffd4c6033f246b (patch) | |
tree | 481f0aa707443bf94410bcd38c43aed78315fa98 /numpy/lib/user_array.py | |
parent | 596795bf697b6be29e21c23d7680e2d476c23436 (diff) | |
download | numpy-2241e6c363da15403a45640382ffd4c6033f246b.tar.gz |
ENH: Allow unnamed return values in Returns section of doc string
Developers usually only need the type of a return value
followed by a brief description. However, in some cases
providing a name for a return value can make the documentation
clearer. This enhancement changes the format of the Returns
section such that the type is required, and the name is
optional:
Returns
-------
int
Description of anonymous integer return value.
x : str
Description of string return value named `x`.
With this change, if a colon is not present, then the entire
line is interpreted as the return type. In all other cases,
the Returns section is interpreted according to the current
rules.
Consistent with the current format, if a colon is present, then
the text to the left of the colon is interpreted as the name;
and the text to the right of the colon is interpreted as the
type. This makes the proposed change backwards compatible with
existing documentation.
Diffstat (limited to 'numpy/lib/user_array.py')
0 files changed, 0 insertions, 0 deletions