[Zope] general API question

[Paul Winkler]

On Sun, Sep 26, 2004 at 03:57:49PM -0400, David Evans wrote:
> is there a more complete API reference available, and if not how can i
> contribute to the update of the curent API to a more complete status?

I've volunteered as editor of the API reference for the next (2.7)
edition of the Zope Book. Help would be greatly
appreciated. 

The version I'm working on is here:
http://www.plope.com/Books/2_7Edition/AppendixB.stx

Note the current TODO list here:
http://www.plope.com/Books/2_7Edition/AppendixB.stx#1-2

Currently what I'm doing is the first item on that list.
A BIG help would be to take responsibility for one or more remaining
modules on the list below.

   * For all modules, classes, methods, and functions in the reference:

      * verify that all names are correct

      * see if any non-private methods are missing, and add them

      * compare API reference to source docstrings and to the HelpSys 
        .stx files, combine and edit all for completeness and clarity.

      * check base classes for things that need documenting - either add 
        the base class to this API ref, or document any non-overridden 
        methods as part of the derived class docs - not sure how best 
        to do this so i'm handling it on a case-by-case basis.

      It's a big job, best done one module at a time.
      So far it takes me about an hour to do one module properly :-(
      Some modules are done, see DONE below.

      The below modules are still to do::
      

        PropertySheet
        PropertySheets
        PythonScripts
        Script
        SessionInterfaces
        TransienceInterfaces
        UserFolder
        Vocabulary
        ZCatalog
        ZSQLMethod
        ZTUtils
        math
        random
        sequence
        standard
        string


-- 

Paul Winkler
http://www.slinkp.com