Re: [Docutils-users] Re: Docstring documentation methodology through reST and Epydoc

[David G. <go...@py...>]

[Felix Wiemann]
 > I'd probably do it like this::
 >
 >     """
 >     Return the current total value as a float for the Field `field`
 >     at accumulator level `level` (int), using the header tuple
 >     `head` (as returned by `Report.get_head()`).
 >     """
 >
 > Thuogh I'm not sure it's valid use of the title-reference role ("`")
 > to denote parameter names or methods.  Maybe it's best to use it now
 > and change the default role later for Python documentation; the
 > rendering (italic) is usually OK, after all.

The default role for inline Python documentation (i.e., docstrings) is
to be "namespace/context-sensitive Python identifier".  So that is a
perfectly valid use; in fact it's the intended use.

--
David Goodger <http://python.net/~goodger>