Write some docs already! (was Re: Python evolution: Unease)

Aahz aahz at pythoncraft.com
Wed Jan 5 13:29:28 EST 2005


In article <10to8qulnc3vke1 at news.supernews.com>,
John Roth <newsgroups at jhrothjr.com> wrote:
>
>I would like to contribute some documentation to Python.  I've got
>the time, I write quite a bit, etc. I've got fairly strong opinions
>about some things that need to be documented, (such as all the new
>style class descriptor stuff from 2.2) and I have relatively little
>difficulty matching the existing style.
>
>However, I don't know TEX, Latex, CVS or Sourceforge. (The latter two
>are on my "learn sometime soon so I can put PyFIT where it belongs"
>list.)
>
>I have no desire to install Perl to run the documentation toolchain.

So don't!  The editors for the Python docs are extremely happy to take
raw ASCII (or reST if you're up for that) and convert it to Python's
formatting rules.  See 2.4's "Documenting Python" -- I finally convinced
the editors to make the policy explicit.

It would be highly desirable for you to learn SourceForge, though; that
way it would be easy for you to participate in the bug/patch process.
But even that isn't essential.

>I also have no particular desire to write up a bunch of final format
>stuff and drop it on someone else to put into the latex format so it
>can be included.

Not clear what you mean here.
-- 
Aahz (aahz at pythoncraft.com)           <*>         http://www.pythoncraft.com/

"19. A language that doesn't affect the way you think about programming,
is not worth knowing."  --Alan Perlis



More information about the Python-list mailing list