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

Chris McDonough chrism at plope.com
Sun Apr 4 18:29:01 EDT 2004


On Sun, 2004-04-04 at 18:15, Paul Winkler wrote:
> On Sun, Apr 04, 2004 at 05:06:52PM -0400, Chris McDonough wrote:
> > The "objects must have a docstring to be publishable" misfeature works
> > against us here too if you want to get docs from code.
> 
> But that would be a non-issue if I create interfaces, right?

Yup...

> > Just pick a module to mark up with interfaces, make
> > the branch, do the interfaces, ask for comments on maillists, and
> > merge.  Wash, rinse, repeat for each module.  It will take a long time,
> > but at least it would be in-progress.  Dealing with the presentation
> > aspect (which IMHO involves killing the help system and replacing it
> > with simple files on a filesystem or chapters in an online book)
> 
> why is killing the current help system necessary? I was thinking of 
> keeping it but having it use docs from these proposed interfaces.

It isn't, I just hate it. ;-)

- C





More information about the Zope-Dev mailing list