[Doc-SIG] quick_reST 0.4.6

[Tony J Ibbs (Tibs)]

David Goodger [mailto:goodger@users.sourceforge.net]
> Tony J Ibbs (Tibs) <tony@lsl.co.uk> wrote on 2001-08-23 11:45:
> > (who's now having mad thoughts about::
> >
> >   .. reSTexample::
> >      :title: Inline markup
> >      :link:  :rest:reStructuredText.html#inline_markup
> >      :plain: ``*emphasis*``
> >      :shown: *emphasis*
> >
> > directives, despite having said to David that one couldn't
> use reST to
> > produce the quick reference...)
>
> Surely we could come up with better syntax than *that*! ;-)

I *said* they were mad thoughts!

And yes, I'm sure we could come up with a better syntax (for, of course,
it is up to the "reSTexample" directive plugin what it does), but *that*
syntax leverages off what we already have, so is both very simple (for
one meaning of the word) and also uses what people have already learnt.

In fact, given the restrictions of the requirements, I would suspect one
would *actually* use something more like::

    .. reSTexample:: Inline markup (:rest:<etc,etc>)
       ``*emphasis*`` | *emphasis*

i.e., a more abbreviated table format. But that would require writing
new code, and might (in the end) be harder to understand.

Anyway, time enough for the future.

Tibs

--
Tony J Ibbs (Tibs)      http://www.tibsnjoan.co.uk/
In Python it's clearer to talk about "names" and "bindings"
rather than "variables" and "values"... "you can't change
the binding of a name in your caller's namespace" doesn't
leave much room for misunderstanding. (Greg Ewing)
My views! Mine! Mine! (Unless Laser-Scan ask nicely to borrow them.)