[Zope3-dev] Re: New Pyskel changes

[Tres Seaver]

On Tue, 2002-07-09 at 13:43, Jim Fulton wrote:

> Note that a doc string should never be about implementation. That's
> what comments are for. OTOH, a doc string may include additional usage
> semantics that a particular implementation provides above and beyond
> the semantics described in the interface. I *think* that that was what
> Guido was refering to.

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, ....
           """

Tres.
-- 
===============================================================
Tres Seaver                                tseaver@zope.com
Zope Corporation      "Zope Dealers"       http://www.zope.com