[Zope3-dev] Re: New Pyskel changes

[Gary Poster]

Tying together what SteveA and Guido and others have suggested: could 
the answer be a CVS-like $IDoc:$ or some-such that was automatically 
updatable from the interface through a simple tool?  My syntax is ugly, 
but perhaps the idea has merit.  i.e., a somehow-prettier version of

   class Foo:
       __implements__ = (IFoo,)
       #...
       def getBar(self, optional_extra_hint=None):
           """ $IDoc: IFoo.getBar
           returns bar.
           $

           'optional_extra_hint', if provided, ....
           """

Does the usefulness outweigh the ugliness, or not so much?

FWIW, the boilerplate docstring is helpful for me, and even if we had 
the full interface doc string available, I would like to know from which 
of the interfaces a given method comes.

Gary


Guido van Rossum wrote:

>>In that case, the 'See IFoo' bit works fine;  it makes it clear that
>>the implementation-specifc bits are extensions of the original. E.g.:
>>
>>   class Foo:
>>       __implements__(IFoo,)
>>       #...
>>       def getBar(self, optional_extra_hint=None):
>>           """ See IFoo.
>>
>>           'optional_extra_hint', if provided, ....
>>           """
>>    
>>
>
>It may work for you.  I've repeatedly stated that it doesn't work for
>me (or for anyone else here at PythonLabs).  That's not an opinion.
>That's a fact.  The boilerplate docstring is unhelpful for me.
>
>--Guido van Rossum (home page: http://www.python.org/~guido/)
>
>
>_______________________________________________
>Zope3-dev mailing list
>Zope3-dev@zope.org
>http://lists.zope.org/mailman/listinfo/zope3-dev
>
>  
>