[SciPy-dev] Docstring convention

Keith Goodman kwgoodman at gmail.com
Mon Jun 2 17:59:51 EDT 2008


What's preferred for documentation? I've seen all of these:

1d or 1D or 1-d
array or ndarray, as in out : array
int or integer, as in out : int (class name is int)
bool or boolean (class name is bool)
shape : tuple    or...
shape : tuple of integers



More information about the SciPy-Dev mailing list