PEP 287: reStructuredText Standard Docstring Format

Terry Reedy tejarex at yahoo.com
Fri Apr 5 12:03:02 EST 2002


"Max M" <maxm at mxm.dk> wrote in message news:3CAD53EC.1010703 at mxm.dk...
> What I don't understand here is that it seems that people considers
> structured text to be difficult. It really isn't. Any programmer can
> learn the basics in 15 minutes or less.
>
> And it really is very very easy to write documents in it. I do
belive
> that if I where ever to write a book (again) i would write it in
ReST.

I have had the same thought myself.

> ########################################
> # 'old' structured text
> ########################################
>
> This is an example of a headline in structured text
>
>      Here is a paragraph.
...

vs.

> ########################################
> # ReST
> ########################################
>
> This is an example of a headline in structured text
> ===================================================
>
> Here is a paragraph.
...

I consider marking subheads and NOT indenting paragraghs to be a
reason to prefer ReST.  Thanks for the feature-by-feature comparison.

Terry J. Reedy






More information about the Python-list mailing list