On 1/23/06, Jeff Watkins <[EMAIL PROTECTED]> wrote:
>
> Kevin Dangoor wrote:
> > Anyone have opinions on these tools?
>
> PythonDoc looks good to me. I'm quite comfortable with the JavaDoc style
> (and much prefer my doc comments to occur before the entity rather than
> the pythonic doc string). I'd be happy to update Identity and Visit to
> support PythonDoc.

docstrings are still good. They're useful for the pydoc command line
tool and help() itnerpreter function. It's just nice to be able to
provide some structured information about what the parameters are,
what the return values are and to be able to link to the other parts
of the documentation easily.

Kevin

Reply via email to