[Pythonmac-SIG] "Official" mac python Docs.
Jack Jansen
jack@oratrix.nl
Mon, 11 Sep 2000 15:26:40 +0200
> Is anyone working on updating the "official" MacPython docs, I mean the
> ones that are on the python.org website, alongside the Library
> Reference, and all that. It looks to me, at a quick glance, that it
> hasn't been updated in a while. AS an example, it still refers to the
> Think C consol package. Has anyone build MacPython with think C
> recently. Does Think C still even exist?
>
> If no one is working on that, I'd be willing to start. I'll need a lot
> of help from the more knowledgable folks on theis group, but I think
> it's a worthy project.
Yes, please please please do so!!!!
You have just gotten yourself elected (or is that appointed:-) to be the
MacPython Documentation Coordinator. Congratulations!
The documentation hasn't been updated in about 4 years or so, I simply haven't
had the time for it. The documentation is currently in the main sourceforge
cvs archive, in a sort of LaTex format. It would be easiest if we can keep it
that way (because the pythonlabs folks will then do all the formatting work
and indexing and such when there is a new release:-), but if that is a problem
we can work out a different scheme. Let me know what formatting package/editor
would work for you, and what organization.
I think that the first step needed is to take inventory of all the
mac-specific modules we have and create an "Undocumented Mac modules" section
in which we list them all. Then we can remove all the obsolete modules in the
existing documentation, and then slowly begin adding documentation for modules
(and removing those modules from the undocumented section).
And all this is just the library section of the manual. The other
documentation, that is currently represented by the htmlfiles in the Mac:Demo
folder and a few bits and pieces elsewhere, could also do with some
organization...
--
Jack Jansen | ++++ stop the execution of Mumia Abu-Jamal ++++
Jack.Jansen@oratrix.com | ++++ if you agree copy these lines to your sig ++++
www.oratrix.nl/~jack | see http://www.xs4all.nl/~tank/spg-l/sigaction.htm