[Twisted-Python] Documentation Lacks
![](https://secure.gravatar.com/avatar/78e124bb69bcaac7a75ecfe640d02261.jpg?s=120&d=mm&r=g)
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
![](https://secure.gravatar.com/avatar/56e4cc78ea7fcf3bb37888ebf23bc1f0.jpg?s=120&d=mm&r=g)
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
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
![](https://secure.gravatar.com/avatar/152986af8e990c9c8b61115f298b9cb2.jpg?s=120&d=mm&r=g)
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka 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? -- ___________ ____________________________ | Screwtape | Reply-To: munged on Usenet |________ ______ ____ __ _ _ _ | | Y. Carnica lecked stempser something? Stedder vorlems chir-ped lookin ferrets. |
![](https://secure.gravatar.com/avatar/b3407ff6ccd34c6e7c7a9fdcfba67a45.jpg?s=120&d=mm&r=g)
On Wed, Jan 01, 2003 at 02:55:38PM +1100, screwtape@froup.com wrote:
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.
![](https://secure.gravatar.com/avatar/152986af8e990c9c8b61115f298b9cb2.jpg?s=120&d=mm&r=g)
On Wed, Jan 01, 2003 at 03:32:47PM +1100, Andrew Bennetts wrote:
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 |
![](https://secure.gravatar.com/avatar/152986af8e990c9c8b61115f298b9cb2.jpg?s=120&d=mm&r=g)
On Sun, Jan 05, 2003 at 03:21:26PM +1100, screwtape@froup.com wrote:
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. |
![](https://secure.gravatar.com/avatar/56e4cc78ea7fcf3bb37888ebf23bc1f0.jpg?s=120&d=mm&r=g)
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
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
![](https://secure.gravatar.com/avatar/152986af8e990c9c8b61115f298b9cb2.jpg?s=120&d=mm&r=g)
On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka 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? -- ___________ ____________________________ | Screwtape | Reply-To: munged on Usenet |________ ______ ____ __ _ _ _ | | Y. Carnica lecked stempser something? Stedder vorlems chir-ped lookin ferrets. |
![](https://secure.gravatar.com/avatar/b3407ff6ccd34c6e7c7a9fdcfba67a45.jpg?s=120&d=mm&r=g)
On Wed, Jan 01, 2003 at 02:55:38PM +1100, screwtape@froup.com wrote:
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.
![](https://secure.gravatar.com/avatar/152986af8e990c9c8b61115f298b9cb2.jpg?s=120&d=mm&r=g)
On Wed, Jan 01, 2003 at 03:32:47PM +1100, Andrew Bennetts wrote:
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 |
![](https://secure.gravatar.com/avatar/152986af8e990c9c8b61115f298b9cb2.jpg?s=120&d=mm&r=g)
On Sun, Jan 05, 2003 at 03:21:26PM +1100, screwtape@froup.com wrote:
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. |
participants (4)
-
Andrew Bennetts
-
Jp Calderone
-
Moshe Zadka
-
screwtape@froup.com