PEP 287: reStructuredText Standard Docstring Format

[Brett Cannon]

On Tue, 2 Apr 2002, David Goodger wrote:

> PEP: 287
> Title: reStructuredText Standard Docstring Format
> Version: $Revision: 1.3 $
> Last-Modified: $Date: 2002/04/02 03:50:38 $
> Author: goodger at users.sourceforge.net (David Goodger)
> Discussions-To: doc-sig at python.org
> Status: Draft
> Type: Informational
> Created: 25-Mar-2002
> Post-History: 02-Apr-2002
> Replaces: 216

+1 vote from me!  Seems to have a good balance of implicit formatting
(back-slashing only when ambiguous, indenting code, doctest using >>>) and
verbose (the :method:doStuff() style).

As for the PEP part, it might as well be adopted.  Since anyone who writes
a PEP will most likely have quite a bit of experience writing docstrings
(and would most likely adopt this), they will already be experienced with
the syntax and thus using it for PEP writing would not be a big hurdle.

Now-if-we-could-only-get-Fred-to-put-all-docs-in-the-modules-using-this-that-would-be-great-ly
y'rs,
Brett C.