[Zope-dev] Reasons for the current API reference docs
implementation?
Dieter Maurer
dieter at handshake.de
Mon Apr 5 03:49:13 EDT 2004
Chris McDonough wrote at 2004-4-4 13:56 -0400:
> ...
>I think the "real" answer
>would be to go and create interfaces for all API classes and turn that
>into an API reference
*BEWARE* however, that interfaces lack information *VITAL* for
an API reference: the constructor description!
Look at the amount of questions in the mailing lists concerning
object construction and you will understand that documentation
of the constructors is necessary beside what is usually
conveyed by an interface.
--
Dieter
More information about the Zope-Dev
mailing list