[Zope-dev] Reasons for the current API reference docs implementation?

[Paul Winkler]

On Sun, Apr 04, 2004 at 02:24:55PM -0400, Stephan Richter wrote:
> On Sunday 04 April 2004 13:56, Chris McDonough wrote:
> > I'm not sure there is a rationale, other than it was composed before
> > Interfaces existed and the "thing to do" at the time was to create docs
> > that went into the hurt^H^H^H^Hhelp system. ?I think the "real" answer
> > would be to go and create interfaces for all API classes and turn that
> > into an API reference (assuming people would update the interfaces when
> > they updated the code.. but that's not a given either I guess). ?I'm not
> > sure that exposing the docstrings of the classes themselves would be
> > much better than the current situation, but then again, I don't want to
> > get in your way if you want to spend time on this godforsaken task.
> 
> Yeah, I guess the best way would be to do interfaces. Then you can use parts 
> of the Zope 3 API documentation tool (actually all of the Interface and Class 
> doc module)  and generate docs.

I note in lib/python/Interfaces/IInterface.py, there are several
ways to declare interfaces currently. Is one of these preferred?

class FooBar:
    implements(IFoo, IBar)


class FooBar:
    __implements__ = (IFoo, IBar)


-- 

Paul Winkler
http://www.slinkp.com
Look! Up in the sky! It's TITANIUM FUNCTIONARY SONGSTRESS!
(random hero from isometric.spaceninja.com)