PEP 287: reStructuredText Standard Docstring Format

Magnus Lie Hetland mlh at vier.idi.ntnu.no
Wed Apr 3 07:16:48 EST 2002


In article <7xd6xhyzvx.fsf at ruckus.brouhaha.com>, Paul Rubin wrote:
[snip]
>I wonder what other systems with inline docs, like Parc Smalltalk or
>the MIT Lisp machine, use for syntax?  Emacs Lisp uses plain text with
>some typographic conventions, but these don't go as far as ReST, and
>it uses a separate system for structured manuals.

How about a syntax like Yodl? It's a markup language I used a bit a
*long* time ago. Heh -- funny -- it's on xs4all, just like Python:

  http://www.xs4all.nl/~jantien/yodl/

I'm not proposing to use the language (at least not necessarily...)
but perhaps the main markup syntax. Yeah, I know -- it's explicit
markup... But it ought to be quite familiar to Pythoneers...

It basically works like em(this). I.e. macros (== markup tags) are
used like function calls. (Hey, they could even be implemented
directly as functions/methods in Python :)

There are a couple of extra syntax additions. I think you can write
foo+(bar) to get the string foo(bar) in your text (without actually
calling a macro) for instance.

Oh, well. Just a thought.

--
Magnus Lie Hetland                                  The Anygui Project
http://hetland.org                                  http://anygui.org



More information about the Python-list mailing list