[Pythonmac-SIG] "Official" mac python Docs Project

[Chris Barker]

Jack Jansen wrote:
> Great! How about my idea of a previous email, that we start adding
> stuff by crating an "undocumented mac modules" section in which we
> start by simply listing them? Or is that overkill, and do you think we
> can finish the documentation quickly enough that this won't be needed?

I think that's a fine idea. See my next post. Any modules that are not
there can be sent to me, with as much info as possible. If nothing else,
I will put the doc string in (if it has anything of use at all) and a
list of the members of the module. What the members do can then be
filled in.

I just went through the doc, and I think I can get it correct pretty
quickly, but there really isn't much point in doing this unless we can
fill it out some, soI'll be focussing on that.

> Another problem, and probably a more difficult one, is modules that
> are implemented but have gotten new methods, or lost methods. IDE's
> modulebrowser can be of some help here, but some things it can't do
> (like finding the methods implemented on a builtin type).

I've started a list of added (and missing) methods of the modules in the
doc. The methods on teh built in types and such I'll jsut have to hope
whoever is using it will be willing to put a little time in to give me
some info.

> > What version of MacPython should I be documenting? is the fianl version
> > of 1.6 out? what about 2.0 (I know you just released and alpha of the
> > installer, but should I try to document that?)
> 
> There won't be a final 1.6, we're going straight to 2.0. By the time
> 1.6 was planned I was far ahead already without any way to turn
> back. And 1.6 was released mainly because CNRI wanted it very much. So
> I'd suggest documenting 2.0b1, which'll be out in an hour or so (or
> possibly tomorrowmorning).

Hmm. when is 2.0 final expected o be released? IN the mean time, I'll go
get the beta. Is 2.0b1 as stable as teh 1.6 beta you had out?

See my next note for some info on the doc.

-Chris


-- 
Christopher Barker,
Ph.D.                                                           
cbarker@jps.net                      ---           ---           ---
http://www.jps.net/cbarker          -----@@       -----@@       -----@@
                                   ------@@@     ------@@@     ------@@@
Water Resources Engineering       ------   @    ------   @   ------   @
Coastal and Fluvial Hydrodynamics -------      ---------     --------    
------------------------------------------------------------------------
------------------------------------------------------------------------