[Twisted-Python] Documentation Lacks
Hi. The following things are undocumented -- any volunteers would be welcome: - conch HOWTO - Twisted chat HOWTO (im, words server, writing bots) - Add tkmktap/tktwistd to basics.html - Twisted news HOWTO - Twisted names HOWTO
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
Hi. The following things are undocumented -- any volunteers would be welcome: [snip] - Add tkmktap/tktwistd to basics.html [snip]
tktwistd isn't quite ready for actual use yet. I'll see about adding tkmktap, though. Jp -- Lowery's Law: If it jams -- force it. If it breaks, it needed replacing anyway. -- 12:00am up 12 days, 9:45, 2 users, load average: 0.00, 0.00, 0.01
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
Hi. The following things are undocumented -- any volunteers would be welcome: - Twisted chat HOWTO (im, words server, writing bots)
In case I accidentally stumble upon some time in the near future, what are the requirements for documentation writing? Are plain text files good enough, or HTML? -- ___________ ____________________________ | Screwtape | Reply-To: munged on Usenet |________ ______ ____ __ _ _ _ | | Y. Carnica lecked stempser something? Stedder vorlems chir-ped lookin ferrets. |
On Wed, Jan 01, 2003 at 02:55:38PM +1100, screwtape@froup.com wrote:
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
Hi. The following things are undocumented -- any volunteers would be welcome: - Twisted chat HOWTO (im, words server, writing bots)
In case I accidentally stumble upon some time in the near future, what are the requirements for documentation writing? Are plain text files good enough, or HTML?
Look at the existing docs in doc/howto for examples. They are in "Lore" format, which is a subset of XHTML. See doc/howto/doc-standard.html for details (or http://twistedmatrix.com/documents/howto/doc-standard). -Andrew.
On Wed, Jan 01, 2003 at 03:32:47PM +1100, Andrew Bennetts wrote:
On Wed, Jan 01, 2003 at 02:55:38PM +1100, screwtape@froup.com wrote:
In case I accidentally stumble upon some time in the near future, what are the requirements for documentation writing? Are plain text files good enough, or HTML?
Look at the existing docs in doc/howto for examples. They are in "Lore" format, which is a subset of XHTML. See doc/howto/doc-standard.html for details (or http://twistedmatrix.com/documents/howto/doc-standard).
And, of course, we will gratefully accept documentation in any reasonable format! It's just that we'll be more grateful if it's in Lore :) -Andrew.
On Wed, Jan 01, 2003 at 03:32:47PM +1100, Andrew Bennetts wrote:
On Wed, Jan 01, 2003 at 02:55:38PM +1100, screwtape@froup.com wrote:
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
Hi. The following things are undocumented -- any volunteers would be welcome: - Twisted chat HOWTO (im, words server, writing bots)
In case I accidentally stumble upon some time in the near future, what are the requirements for documentation writing? Are plain text files good enough, or HTML?
Look at the existing docs in doc/howto for examples. They are in "Lore" format, which is a subset of XHTML. See doc/howto/doc-standard.html for details (or http://twistedmatrix.com/documents/howto/doc-standard).
Well, I've had a go at documenting my experiences with Twisted IM. How's this? -- ___________ ____________________________ | Screwtape | Reply-To: munged on Usenet |________ ______ ____ __ _ _ _ | | "Universe-flavored. What you mortals call `butterscotch'." -- T&R, 1999-09-17 |
On Sun, Jan 05, 2003 at 03:21:26PM +1100, screwtape@froup.com wrote:
On Wed, Jan 01, 2003 at 03:32:47PM +1100, Andrew Bennetts wrote:
On Wed, Jan 01, 2003 at 02:55:38PM +1100, screwtape@froup.com wrote:
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
Hi. The following things are undocumented -- any volunteers would be welcome: - Twisted chat HOWTO (im, words server, writing bots)
In case I accidentally stumble upon some time in the near future, what are the requirements for documentation writing? Are plain text files good enough, or HTML?
Look at the existing docs in doc/howto for examples. They are in "Lore" format, which is a subset of XHTML. See doc/howto/doc-standard.html for details (or http://twistedmatrix.com/documents/howto/doc-standard).
Well, I've had a go at documenting my experiences with Twisted IM. How's this?
Andrew tapped me on the shoulder on IRC and told me where to find hlint. *blush* -- ___________ ____________________________ | Screwtape | Reply-To: munged on Usenet |________ ______ ____ __ _ _ _ | | Fried eye car nelpew. |
On Sun, Jan 05, 2003 at 03:45:32PM +1100, screwtape@froup.com wrote:
On Sun, Jan 05, 2003 at 03:21:26PM +1100, screwtape@froup.com wrote:
Well, I've had a go at documenting my experiences with Twisted IM. How's this?
Andrew tapped me on the shoulder on IRC and told me where to find hlint.
I've checked this in (with some minor adjustments). Thanks! -Andrew.
On Wed, 1 Jan 2003, screwtape@froup.com wrote:
In case I accidentally stumble upon some time in the near future, what are the requirements for documentation writing? Are plain text files good enough, or HTML?
See the "Documenting Twisted" HOWTO, in the HOWTO collection. It gives more information than you want about it.
participants (4)
-
Andrew Bennetts -
Jp Calderone -
Moshe Zadka -
screwtape＠froup.com