[Numpy-discussion] Default value in documentation

Pierre GM pgmdevlist@gmail....
Tue Oct 2 12:23:43 CDT 2007

I'm starting to update the documentation of maskedarray to the latest 
How should I represent the default value of an optional parameter ?
I was thinking something like

def function(a, value=None)
    """Does something
    a : {ndarray}
        Input array.
    value : {float} *[None]*
        Some value. If None, a default based on the dtype of a is used.

Suggestions/ideas are welcome.
Thanks a lot in advance

More information about the Numpy-discussion mailing list