Hi Tibor,
In data Monday 06 April 2009, Tibor Simko scribacchiaste dette parole:
> | @type m: number
> | @param m: The slope of the line.
> | @type b: number
> | @param b: The y intercept of the line. The X{y intercept} of a
> | line is the point at which it crosses the y axis (M{x=0}).
> | @rtype: number
> | @return: the x intercept of the line M{y=m*x+b}.
> [...]
> Please look at <http://epydoc.sourceforge.net/manual-epytext.html> to
> see what epydoc/epytext can do.
>
> N: We currently use several docstring styles in the CDS Invenio sources
> (none, free style, lisp style, javadoc style). Our code browser demo
> page for CDS Invenio does not look too good, because we don't use the
> epytext markup. (Well, epydoc could use the Javadoc markup with some
> @type extensions too, but we are not complete there either).
>
> Once we choose some code documentation browser software and some
> docstring markup, then we should progressively migrate all our
> docstrings towards the new style for the whole codebase.
>
> Q: Do you like epydoc/epytext combination? Okay to go for it?
Yes :-) Just I think that it might worth seeing if we can already exploit our
Javadoc markup that as you said we already used...
> Q: Do you have any alternative proposals to epydoc/epytext?
Well, there's the pydoc -p option, which is just few steps ahead than than
help pages in iPython, but I think that the formatting capabilities of epydoc,
if exploited, make epydoc IMHO a far better choice...
Cheers,
Sam
--
Samuele Kaplun ** CERN Document Server ** <http://cds.cern.ch/>
