[Numpy-discussion] parameter types for documentation

[Ralf Gommers]

On Sun, Oct 25, 2009 at 12:42 AM, Christopher Burns <cburns at berkeley.edu>wrote:

> Cool, thanks.  Mind if I update the HOWTO_DOCUMENT adding in the
> partial list below?
>
> Sure, that would be useful. While you're at it, could you get rid of the
{True, False}?

Cheers,
Ralf



> 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"
> >
> _______________________________________________
> NumPy-Discussion mailing list
> NumPy-Discussion at scipy.org
> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20091025/bc218149/attachment.html>