On Tue, 2 Oct 2007, Charles R Harris apparently wrote:
> We're avoiding consolidated fields because they behave
> badly. ... The main problem with the consolidated fields
> is that they are all put together as item lists in
> a definition list and moved to the end of the docstring
> when it is
Hi Pierre,
On 10/2/07, Pierre GM <[EMAIL PROTECTED]> wrote:
>
> On Tuesday 02 October 2007 15:36:03 Alan G Isaac wrote:
> > On Tue, 2 Oct 2007, Pierre GM apparently wrote:
> > > is there any kind of standard to describe the attributes
> > > of a class, a la :IVariables: in epydoc ?
> >
> > I thoug
On Tuesday 02 October 2007 15:36:03 Alan G Isaac wrote:
> On Tue, 2 Oct 2007, Pierre GM apparently wrote:
> > is there any kind of standard to describe the attributes
> > of a class, a la :IVariables: in epydoc ?
>
> I thought it was ... :IVariables:
> i.e., I thought the standard was reST as hand
On 10/2/07, Alan G Isaac <[EMAIL PROTECTED]> wrote:
>
> On Tue, 2 Oct 2007, Pierre GM apparently wrote:
>
> > is there any kind of standard to describe the attributes
> > of a class, a la :IVariables: in epydoc ?
>
> I thought it was ... :IVariables:
> i.e., I thought the standard was reST as hand
On Tue, 2 Oct 2007, Pierre GM apparently wrote:
> is there any kind of standard to describe the attributes
> of a class, a la :IVariables: in epydoc ?
I thought it was ... :IVariables:
i.e., I thought the standard was reST as handled by epydoc.
http://projects.scipy.org/scipy/numpy/wiki/Coding
On Tue, Oct 02, 2007 at 12:25:58PM -0600, Charles R Harris wrote:
> So label it optional and describe the default in prose in the parameter
> description if necessary. While this is less descriptive for meaningful
> defaults
> (axis=-1), the case you show above is precisely suited t
On 10/2/07, Robert Kern <[EMAIL PROTECTED]> wrote:
>
> Pierre GM wrote:
> > All,
> > I'm starting to update the documentation of maskedarray to the latest
> > standard.
> > How should I represent the default value of an optional parameter ?
> > I was thinking something like
> >
> > def function(a,
On Tuesday 02 October 2007 13:40:28 Robert Kern wrote:
> I prefer this:
>
> value : {float}, optional
> Some value. If not provided, a default based on the dtype of a is
> used.
>...
>And for the meaningful defaults, the function
> signature is more than adequate to provide the necessa
Pierre GM wrote:
> All,
> I'm starting to update the documentation of maskedarray to the latest
> standard.
> How should I represent the default value of an optional parameter ?
> I was thinking something like
>
> def function(a, value=None)
> """Does something
> *Parameters*:
> a : {ndar
All,
I'm starting to update the documentation of maskedarray to the latest
standard.
How should I represent the default value of an optional parameter ?
I was thinking something like
def function(a, value=None)
"""Does something
*Parameters*:
a : {ndarray}
Input array.
value :
10 matches
Mail list logo
