[Epydoc-devel] Convention for referencing params in function documentation

[Joseph T. <tu...@gm...>]

What is the appropriate convention for referencing params in function
documentation?
e.g.

def max(x):
   """
   @return: The largest element of I{x}.
   """

(Obviously, I could make @param x:, but this is just for the sake of
explanation.)

Is there a convention for annotation params in the function documentation?
I could italicize them all, but this is brittle and one may want to change
the formatting later on.

Thanks,
   Joseph

-- 
Academic: http://www-etud.iro.umontreal.ca/~turian/
Business: http://www.metaoptimize.com/