[Docutils-develop] Re: Removing options lists and doctest blocks

[Felix W. <Fel...@gm...>]

Martin Blais wrote:

> I was having a discussion w/ D.Goodger this morning--I'm lucky to be
> working the same building as he is these days, so I have physical
> access his ultra-brain device, and I can use the efficient "human
> voice" communication protocol with it.

Cool.

Thanks for your suggestions.  I'll just quickly summarize my thoughts --
I don't have much time, sorry.

> [Bad elements that could possibly removed:]
>
> * all the *options list* elements.

I think that there is not sufficient reason to remove the option list
syntax construct.

Since we have no way to represent option lists without the option_list
node, we have to keep at least the top-level nodes of option lists.

Pasting in an example::

    $ rst2pseudoxml.py
    --option  Description.
    <document source="<stdin>">
        <option_list>
            <option_list_item>
                <option_group>
                    <option>
                        <option_string>
                            --option
                <description>
                    <paragraph>
                        Description.

Everything below the option_group node is overkill, so I'm fine with
removing these elements.  I'm not sure if the name "option_group" makes
much sense without the other option nodes, and if it the option_group
node should be renamed.

> * the *doctest* blocks.

Again, I don't think we should remove the syntax construct unless we
have a really good reason.  I'm fine however with removing the doctest
element, using literal_block instead.

-- 
For private mail please ensure that the header contains 'Felix Wiemann'.

"the number of contributors [...] is strongly and inversely correlated with the
number of hoops each project makes a contributing user go through."      -- ESR