[Twisted-Python] Towards 1.0

Andrew Bennetts andrew-twisted at puzzling.org
Thu Apr 11 21:06:01 MDT 2002


On Thu, Apr 11, 2002 at 10:53:57PM -0400, M.J. Stahl wrote:
> Excellent... I having been wanting to write documentation on Twisted for 
> a while, and my interest has increased due to my large interest in Reality.
> 
> The only problem that I have when trying to get involved in this aspect 
> is the needed directions from the people running the show. I would like 
> to know what you need documented and how you would like the docs to 
> look. (info about the system in general, tutorials, as well as a listing 
> of API's and the information needed for programmers to use them).

I believe there is a Twisted Documentation Standard now distributed
with 0.17.0 and later.  Alternatively, see:
    http://twistedmatrix.com/documents/howto/doc-standard

As for what we need documented, basically everything! :)

See doc/howto/book.html in a recent Twisted distribution to get some
idea of what is wanted.

Thanks!  People who write docs rock!

-Andrew.





More information about the Twisted-Python mailing list