Re: [Epydoc-devel] Docstring parsing shortcomings

[Hans M. <me...@in...>]

Am Freitag, 11. Mai 2007 15:52:27 schrieb Daniele Varrazzo:
> About a point you have raised somewhere else: when a docstring is more than
> a paragraph long, only the first is printed in the summary table, while the
> complete docstring content is put in a box below. You may found this, and
> other useful hints, in the fine manual (tm) ;)

I know that (also from e.g. javadoc, Doxygen), and like it.

What I wanted to say is that I have found several examples where the latter 
(the complete docstring) is missing.  I.e. in the summary the first sentence 
is given, but it is *not* a link, and there is nothing to be linked to.  In 
the last mail I attached a simple test case that fails with epydoc-3.0beta1, 
and I just found another one:

def parseGeometry(geometryString):
	"""Convenience function for parsing geometry strings of various
	formats::

	  >>> fig.parseGeometry("320,240-640,480")
	  fig.Rect(320,240,640,480)
	  >>> fig.parseGeometry("50,50+50,50")
	  fig.Rect(50,50,100,100)
	  >>> fig.parseGeometry("40,40,320,240")
	  fig.Rect(40,40,320,240)
	  >>> r = fig.Rect(0,0,320,240)
	  >>> fig.parseGeometry(str(r)) == r
	  True
	"""
	ma = _re_geometry.match(geometryString)

These docs are not listed in the "function details" section either. :-(

-- 
Ciao, /  /
     /--/
    /  / ANS