[wingide-users] epydoc!

Linos info at linos.es
Wed Oct 5 07:50:24 MDT 2011


El 05/10/11 14:25, Michael Foord escribió:
> On 04/10/2011 17:53, Jason L Connor wrote:
>> On Tue, 2011-10-04 at 17:32 +0100, Michael Foord wrote:
>>> Although epydoc itself is dead, right? (No longer maintained and
>>> pretty serious bugs in the output from the last released version.)
>> I don't really think there are serious bugs in it. I'm not sure if it's
>> still maintained or not. Personally I use it all the time.
> 
> Last time I used it the generated html for source files was horribly mangled and
> I'm pretty sure there have been no new releases since.
>>
>>> Does sphinx, along with its autodoc extensions, have any convention
>>> around parameter types and return values? 
>> It does. In it's python domain it also uses the type and rtype
>> documentation. For example:
>>
>> def my_func(arg1, arg2):
>>     """
>>     :param arg1: first argument
>>     :type arg1: int
>>     :rtype: str
>>     """
>>
> 
> I would be very happy to see Wing support the sphinx annotations.
> 
> Michael
> 

I have 0 experience with sphinx, do know anyone if it is possible to annotate
the type of a variable in code? Not only function signatures i mean.

Miguel Angel.


More information about the wingide-users mailing list