PEP 287: reStructuredText Standard Docstring Format

[David Goodger]

Richard Jones wrote:
> On Wed, 3 Apr 2002 11:53, Peter Hansen wrote:
>> I would suggest an even shorter version of the quickref, focused on
>> only those items needed in 80% of embedded documentation.  It does
>> _look_ complicated at first.
> 
> I agree - I think the quickref definitely needs:
> 
> 1. reorganising to filter the most common, simple markup to the top, and
> 2. much higher status/metioning on the ReST website.

You're both talking about a "Gentle Introduction" document, I think.
There's certainly room for one -- any volunteers?

I like the quickref as it is though, a true "Quick Reference".  It should be
reasonably complete, for quick lookups (that's why I added the table of
contents).  It's not really suitable as a primer though, and that document
doesn't exist yet.

-- 
David Goodger    goodger at users.sourceforge.net    Open-source projects:
 - Python Docstring Processing System: http://docstring.sourceforge.net
 - reStructuredText: http://structuredtext.sourceforge.net
 - The Go Tools Project: http://gotools.sourceforge.net