[Zope-dev] Re: Future of StructuredText
Simon Michael
simon@joyful.com
Wed, 04 Sep 2002 20:23:57 -0700
Simon Michael <simon@joyful.com> writes:
> The doc I read listed a large number of rules, including many that seemed
> to want to exert more control over my text than they should. (I had a
I tracked it down - it was the example rST PEP posted in comp.lang.python.
So that would explain it. I read stuff like the below as being part of
rST, when presumably they are a PEP thing.
I don't think rST is the best of all possible markups (yet), but it's
better than I might have suggested yesterday.
-Simon
----------------------------------------------------------------------
(example rST PEP):
"You must adhere to the Emacs convention of adding two spaces at the
end of every sentence. You should fill your paragraphs to column 70,
but under no circumstances should your lines extend past column 79.
If your code samples spill over column 79, you should rewrite them.
...
Tab characters must never appear in the document at all. A PEP should
include the standard Emacs stanza included by example at the bottom of
this PEP.
...
PEP headings must begin in column zero and the initial letter of each
word must be capitalized as in book titles. Acronyms should be in all
capitals.
...
You shouldn't have more than five levels of sections in your PEP. If
you do, you should consider rewriting it.
...
You must use two blank lines between the last line of a section's body
and the next section heading. If a subsection heading immediately
follows a section heading, a single blank line in-between is
sufficient."