[Doc-SIG] [Python-Dev] status of development documentation

Steve Holden steve at holdenweb.com
Wed Dec 21 21:49:26 CET 2005


Laura Creighton wrote:
> Whenever people have demanded that I write documentation in html
> I have always done this:
> 
> <pre>
> all my documentation, as output from a text editor.
> 
> All subsequent formatting to be done by somebody else who doesn't
> find dealing with html as excruciatingly painful as I do.
> </pre>
> 
> I suspect there are lots of people who have concluded that this
> is all the html that you really need.  The question is, are you
> willing to put up with documentation like this from people?
> 
Well the existing system can cope with that style, but for some reason 
the oft-repeated advice that plain text markup is an acceptable format 
for documentation contributions doesn't seem to have escaped the gravity 
field. So that's just as good for the existing docs as anything that 
replaces them (if anything does).

regards
  Steve
-- 
Steve Holden       +44 150 684 7255  +1 800 494 3119
Holden Web LLC                     www.holdenweb.com
PyCon TX 2006                  www.python.org/pycon/



More information about the Doc-SIG mailing list