[Numpy-discussion] parameter types for documentation

Christopher Burns cburns at berkeley.edu
Sat Oct 24 18:42:46 EDT 2009


Cool, thanks.  Mind if I update the HOWTO_DOCUMENT adding in the
partial list below?

Chris

On Sat, Oct 24, 2009 at 3:19 PM, Ralf Gommers
<ralf.gommers at googlemail.com> wrote:
> Not all of them are listed in one place. For general advice, see the
> Parameters section of
> http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
> One error on that page is {True, False}, that should be bool.
>
> str is correct, string is not. Reason: str is the type.
>
> Partial list:
> str
> bool
> list
> tuple
> sequence
> ndarray
> array_like
>
> or if you can be more precise:
> list of str
> sequence of ints
>
> and for keywords, add ", optional"
>



More information about the NumPy-Discussion mailing list