Re: [Epydoc-devel] Docstring parsing shortcomings

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

Hi again!

Am Freitag, 11. Mai 2007 00:38:02 schrieb Edward Loper:
> Perhaps boost and/or sip could be encouraged to include some
> introspectable value that can be used to find the signature?  Either
> by automatically including a signature at the beginning of the
> __doc__ attribute, or by adding a new attribute to the object?  If
> they did that, I'd be happy to add support to epydoc for reading it.
I posted a request for that on the c++-sig list (boost::python development 
list), but so far, nobody volunteered:
http://mail.python.org/pipermail/c++-sig/2007-May/012355.html

(Yes, I know the signature-in-docstring sentence is wrong, since they are not 
discouraged in extension modules AFAICS.)

Would you be willing to add support for the extended docstrings with C++ 
signature?  Now that I built the new boost::python 1.34.0beta, I am swamped 
in docutils warnings:

+---------------------------------------------------------------------------------------------------------------
| File /home/meine/local-SuSE-10.2/lib/python2.4/hourglassmodule.so, in 
hourglass.DynamicCostQueue.empty
|   Warning: Unexpected indentation.
|
+---------------------------------------------------------------------------------------------------------------
| File /home/meine/local-SuSE-10.2/lib/python2.4/hourglassmodule.so, in 
hourglass.DynamicCostQueue.insert
|   Warning: Unexpected indentation.
|
...

This is because the docstrings now look like this one:
> Return True iff pop() can deliver another pair.
> C++ signature:
>     empty(vigra::DynamicCostQueue {lvalue}) -> bool

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