[SciPy-Dev] {True, False} should be replaced w/ bool, correct?

Ralf Gommers ralf.gommers@googlemail....
Thu Jun 3 09:26:00 CDT 2010


On Thu, Jun 3, 2010 at 10:10 PM, Vincent Davis <vincent@vincentdavis.net>wrote:

> On Thu, Jun 3, 2010 at 4:40 AM, Ralf Gommers
> <ralf.gommers@googlemail.com> wrote:
> >
> >
> > On Thu, Jun 3, 2010 at 1:04 PM, David Goldsmith <d.l.goldsmith@gmail.com
> >
> > wrote:
> >>
> >> Just checking; see, e.g., scipy.io.matlab.mio.savemat appendmat
> >> parameter.  (Or is it possible that the function really needs to see
> either
> >> the word True or the word False?)
> >
> > Correct, {True, False} should always be changed to bool in the docs.
>
> I didn't see how the "defualt" should be noted on bool options. I
> think in most cases it should be clear but it might be nice is it was
> explicit.
>
> In the description of the parameter, for example:
cap : bool, optional
    Whether to return this string in capital letters. Default is True.

Noting defaults should be done not only for bool args, but for everything
that has a default.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20100603/9407f570/attachment.html 


More information about the SciPy-Dev mailing list