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

[Stephan Richter]

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.

Regards,
Stephan
-- 
Stephan Richter
CBU Physics & Chemistry (B.S.) / Tufts Physics (Ph.D. student)
Web2k - Web Software Design, Development and Training