Hey, documentation-complainers! I know you're out there, and I know you read this blog. As you know, if you want to learn about Twisted, there is a book you can buy.
However, thanks to JP's tireless adjustment of margins, there is now a book you can get for free as well. It's a nicely typeset version of the web-based documentation for Twisted's core, with a paginated table of contents, which you can print out and read on paper, if that's your thing. This book is 255 pages - and it only covers the core portions of Twisted.
At some point I'm going to try to put together an "extended mix" version of this book, that includes documentation of the less well-documented and stable parts of twisted. For now, though, I'll trust it'll take you all a little while to get through the first 250 pages :).
Posts
3 comments:
I just got this image of someone locking you, JP, and the others in a room for a week and publishing "TWISTED: the missing manual" in the following week :-)
I would also like to see a treatment of web2 in the next version!
However, the material you cite is written, in direct contradiction of our coding standard, in a format which our existing documentation process cannot incorporate. (It's in ReStructured Text, everything else is written in Lore/HTML.)
You should give the web2 devs a hard time about converting it over to Lore :).
Oh, also... I would really like to see streams removed from web2 before the API is declared stable (and we start documenting it and presenting it as finished). We already have several very workable ways of moving bytes between producers and consumers of data in Twisted, and streams drag in a ton of extra complexity without providing any real advantages.
Post a Comment