On Sun, Oct 17, 2010 at 12:54 PM, Nikolaus Rath <nikol...@rath.org> wrote:
> Hello,
>
> I often use docstrings like this:
>
>    def access(self, inode, mode, ctx, get_sup_gids):
>        '''Check if requesting process has `mode` rights on `inode`.
>
>        [more stuff]
>        '''
>
> The autodoc module chokes on this, because 'mode' and 'inode' are not
> python functions (I have set the default role to 'py:obj').
>
> What role should I use when referring to function parameters in the
> docstring?

The Python std lib docs just use *italics*.

Cheers,
Chris

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to