[Twisted-Python] More on docs
Sorry, I appreciate that I spend more time ranting about getting help writing docs than I do writing, but... again. Unfortunately the fastest way for me to write docs is to take rough drafts by someone else and edit them into a helpful style with examples and whatnot. Writing docs from scratch is fairly slow because I have to spend a lot of time with the code, far more than the developers would have to spend. And usually anything I say about design designs or high level rationale will subsequently need to be corrected. So, it would be fastest *for me* if developers wrote scratch drafts and I edited them and improved the examples etc. Which is great, but also unlikely to happen. I figure something that is more likely to happen is that developers will be explaining something to someone and accidently generate drafts as they go. For example: mailing list posts, IRC logs and blog entries. So, if you see or participate in a good "using something" discussion, particularly on IRC, please send me a copy and I'll do my best to edit/re-write it into a usable piece of documentation. As my part of the bargain, it really is time I went back through the archives and mined them for good posts. Ta, Mary
Mary Gardiner wrote: ...
http://blog.vrplumber.com/356 http://blog.vrplumber.com/358 http://blog.vrplumber.com/371 http://blog.vrplumber.com/349 http://blog.vrplumber.com/310 http://www.vrplumber.com/programming/twistedlowlevel05.pdf Covering, respectively: Creating an SSL-protected web-server with Twisted Adding user authentication to your web-site via twisted.cred/nevow.guard Converting user authentication from "in-memory" checker to PostgreSQL-based checker Creating a twisted.manhole Python telnet prompt (minimal example) How to download an SSL-encrypted web-page (minimal example) Talk on low-level mechanisms in Twisted, with background on other common methods of parallelisation HTH, Mike ________________________________________________ Mike C. Fletcher Designer, VR Plumber, Coder http://www.vrplumber.com http://blog.vrplumber.com
Mary Gardiner wrote: ...
http://blog.vrplumber.com/356 http://blog.vrplumber.com/358 http://blog.vrplumber.com/371 http://blog.vrplumber.com/349 http://blog.vrplumber.com/310 http://www.vrplumber.com/programming/twistedlowlevel05.pdf Covering, respectively: Creating an SSL-protected web-server with Twisted Adding user authentication to your web-site via twisted.cred/nevow.guard Converting user authentication from "in-memory" checker to PostgreSQL-based checker Creating a twisted.manhole Python telnet prompt (minimal example) How to download an SSL-encrypted web-page (minimal example) Talk on low-level mechanisms in Twisted, with background on other common methods of parallelisation HTH, Mike ________________________________________________ Mike C. Fletcher Designer, VR Plumber, Coder http://www.vrplumber.com http://blog.vrplumber.com
participants (2)
-
Mary Gardiner -
Mike C. Fletcher