[Doc-SIG] using the same delimiter on the left and right..

Guido van Rossum guido@digicool.com
Thu, 29 Mar 2001 12:53:59 -0500


> Still, some may just not consider punctuation-style cues for markup to be
> acceptable.  That would be a shame - i think for situations like
> docstrings and brief, day-to-day content, such limited-scope, dirt-simple
> markup is the right way to go, if implemented well...

I'm concerned about the attitude that docstrings are stuff you
shouldn't care too much about.  Python docstrings are used to document
constructs in a programming language.  Precision is of the essence.
We *need* to be able to control every single character of the output.

I think the most important requirements are to be able to indicate
what is free-flowing, normal text and what isn't (either inline
example text or larger blocks of literal text).  Everything else is
secondary.

--Guido van Rossum (home page: http://www.python.org/~guido/)