Re: [Epydoc-devel] Epytext markup enhancement suggestions

[Huu Da T. <huu...@gm...>]

Edward Loper wrote:

>> 2. Leave out @type, @rtype and describe type inline as the first word of
>> parameter paragraph.
> 
> I wouldn't mind adding some syntax that would allow types to be
> optionally specified as part of a parameter/returns field.  With your
> proposal this would look like (keeping the ":" because I like it):
> 
> @param int x: the x coordinate
> 
> I also wouldn't mind any number of alternatives, including:
> 
> @param x (int): the x coordiante
> @param x [int]: the x coordinate

I like the () option as it looks like cast. It is a great idea for 
simple type, but when extending it complex type (or with formatting), I 
believe it would be hard to read. How would this be translated into the 
suggested format?

@param var1: first param.
@type var1: C{int} | C{None}
@param var2: an object
@type var2: L{search<re.search>}


-- 
Huu Da Tran <huu...@gm...>
Fidèle esclave des félins

Qui m'insulte, parfois, me dit la vérité.
Qui me flatte, plus souvent qu'autrement, me ment!