Re: [Docutils-users] Documenting parameters of functions

[Sam P. <sam...@gm...>]

On 24/09/2008, Alan G Isaac <ai...@am...> wrote:
> On 9/24/2008 3:51 AM Ben Finney apparently wrote:
>  > Rather than new directives (that, as you point out, cause problems
>  > when the directives are not defined), I've seen this problem addressed
>  > with reST field lists: one field per parameter, and one for the return
>  > value::
>
>
> A related approach: http://epydoc.sourceforge.net/fields.html
>  (Scroll to bottom.)

The field list definately seems like the solution.  Both :param : and
:return : seem common amongst sphinx and epydoc, which is encouraging.

I did consider field lists at one point, but disliked the table
output, but I can live with that if there is a convention growing.

I'd not seen Sphinx before, despite looking for a tool that did more
or less exactly that.

Many thanks to all for your advice.

Sam