On Tue, Feb 26, 2008 at 3:52 PM, Stefan Seefeld <seefeld@...> wrote:
> I'm using ReStructuredText embedded in source code (various languages)
> for documentation. One of the most common case is documenting parameters
> (e.g., fuction parameters, template parameters, etc.). I have had a look
> at the possible RST syntax to express such listings, but they all appear
> to require individual items to be spread across multiple lines (I'm
> notably thinking of definition lists).
> Is there anything more compact that I could use ? For example in python:
> def func(a, b, c):
> """Function func.
> a: The first argument.
> b: The second argument.
> c: The third argument.
- a: The first argument.
- b: The second argument.
- c: The third argument.
:a: The first argument.
:b: The second argument.
:c: The third argument.
The advantage of field lists is that the syntax separates the name
from the content.
> epydoc suggests 'consolidated fields', but that isn't part of RST, or is
> it ?
I don't know what those are. URL?
David Goodger <http://python.net/~goodger>