Hi again!
Am Freitag, 11. Mai 2007 14:08:37 schrieben Sie:
> 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).
Ah, great, thanks. That's what I was looking for (maybe put into the FAQ?),
and I even used the rst syntax in several places for arguments, but I did not
come across a working example. That said, what happens here - the docstring
seems to be truncated (after the first sentence, there is not detailed doc
extracted)?!
class Face(object):
def contour(self, index = 0):
"""face.contour(index)
Returns the index'th contour (same as
``face.contours()[index]``, but more convenient).
`index` defaults to 0, which is the exterior contour
(except for Face 0, the infinite face)."""
return self._anchors[index].clone()
See the attached code, make docs with
epydoc -v --docformat restructuredtext epydoctest2
Is this a bug in the beta version?
Ciao, / /
/--/
/ / ANS
PS: It would be more convenient if ~"always reply to list" was activated in
the mailman options.
|
