Re: [Epydoc-devel] Docstring parsing II: Links between functions, argument highlighting?
Brought to you by:
edloper
From: Edward L. <ed...@gr...> - 2007-05-11 12:08:33
|
On May 11, 2007, at 7:54 AM, Hans Meine wrote: > I would expect this to be a FAQ, but I could not find any evidence > that epydoc > supports automatic cross-referencing of function names? It would > be cool if > refererences within docstrings to other functions or to function > arguments > were recognized and treated specially. Crossreferences must be made explicitly, but the markup is pretty light. For rst, `foo` or `foo()` or `Foo.foo` etc. (i.e., use backticks). For epytext, X{foo} or X{foo()} etc. You can also use X {foo<fully-qualified-name>} or `foo<fully-qualified-name>` to give short text in the output (foo) for an object that's not locally defined or imported. I chose to use explicit markup, because often function, object, & classes have names that are English words; and I didn't want crossreference links created in inappropriate places. -Edward |