PEP 287: reStructuredText Standard Docstring Format

Max M maxm at mxm.dk
Wed Apr 3 03:48:59 EST 2002


David Goodger wrote:
> Here's a serious proposal, safe to post now that April Fool's is over.
> Please read & comment.

Through Zope I have used Structured text extensively. Also I have good 
experience teaching stuctured text to my customers. After a very short 
while they start to use it insted of html when generating content for 
their sites due to ease of use.

A very nice bonus that isn't mentioned in the PEP is that it is very 
easy to store the text in a database and then query in free text. No 
need to parse it beforehand to remove markup tags.

Structured text is easy to write and easy to read, and flexible enough 
to write documentation that contains code. So in theory it could even be 
used in a *readable* literate programming tool.

Something that I would like to use for writing better documentation.

regards Max M




More information about the Python-list mailing list