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

[Vincent Davis]

n Thursday, June 3, 2010, David Goldsmith <d.l.goldsmith at gmail.com> wrote:
> On Thu, Jun 3, 2010 at 7:26 AM, Ralf Gommers <ralf.gommers at googlemail.com> wrote:
>
>
>
> On Thu, Jun 3, 2010 at 10:10 PM, Vincent Davis <vincent at vincentdavis.net> wrote:
>
> On Thu, Jun 3, 2010 at 4:40 AM, Ralf Gommers
> <ralf.gommers at googlemail.com> wrote:
>>
>>
>> On Thu, Jun 3, 2010 at 1:04 PM, David Goldsmith <d.l.goldsmith at 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.

Not sure what I was looking at but it did not state the default,
that's way I ask and I didn't see anything in the guide but I might
have missed it.
vincent
>
> Cheers,
> Ralf
>
> Thanks, Ralf.  Let me just add that if the default isn't clear in the existing docs, it may be necessary, as the editor, to look at the source.  Thanks again.
>
> DG
>
>