[Twisted-Python] Documentation Lacks

screwtape at froup.com screwtape at froup.com
Sat Jan 4 21:45:32 MST 2003


On Sun, Jan 05, 2003 at 03:21:26PM +1100, screwtape at 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 at 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.
|
-------------- next part --------------
An HTML attachment was scrubbed...
URL: </pipermail/twisted-python/attachments/20030105/78247ef4/attachment-0002.html>


More information about the Twisted-Python mailing list