[Doc-SIG] docutils status report
Edward Welbourne
Edward Welbourne <eddy@chaos.org.uk>
Tue, 19 Dec 2000 18:43:13 +0000 (GMT)
> 8. Recognise descriptive list items (note that markup is allowed in
> the "title" of the item, so one can do::
>
> ' -- ' -- This is an awkward case
but, for all that, a necessary one. Consider, for instance, the
docstring of a function called main which parses the command-line of a
program which supports, among other things, some --long-style flags; the
doc-string will need to use the flags as keys in a descriptive list !
Meanwhile, consider (e.g.) a function whose docstring lists the ways a
line can start a list item, in which one might say:
1. -- ordered list (using arabic numerals)
I. -- ordered list (using uppercase roman numerals)
i. -- ordered list (using lowercase roman numerals)
a. -- ordered list (lowercase alphabetic lables)
A. -- ordered list (uppercase alphabetic labels)
o. -- `unordered' list, i.e. bulletted (unless preceded by list items a...n)
which, clearly, I want to see as a description list, not a very confused
ordered list. Will that work ? and can I use `1)' and `a)' instead of
`1.' and `a.' ? (as lead-in to list items)
Eddy.