summaryrefslogtreecommitdiff
path: root/docs/dev/rst
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-04-30 02:22:22 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-04-30 02:22:22 +0000
commitb5f1e2618bd540436686dc1593d2c398b9558f00 (patch)
tree6d1c21c842ba6cc81b5600ce3ea2173c97143d52 /docs/dev/rst
parent29e9868d5635c52603e8101344cf26169bfa5328 (diff)
downloaddocutils-b5f1e2618bd540436686dc1593d2c398b9558f00.tar.gz
updated
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@55 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/dev/rst')
-rw-r--r--docs/dev/rst/problems.txt43
1 files changed, 26 insertions, 17 deletions
diff --git a/docs/dev/rst/problems.txt b/docs/dev/rst/problems.txt
index f366bdf3f..e97887a01 100644
--- a/docs/dev/rst/problems.txt
+++ b/docs/dev/rst/problems.txt
@@ -213,27 +213,36 @@ People will write enumerated lists in all different ways. It is folly
to try to come up with the "perfect" format for an enumerated list,
and limit the docstring parser's recognition to that one format only.
-Rather, the parser should recognize a variety of enumerator styles,
-marking each block as a potential enumerated list item (PELI), and
-interpret the enumerators of adjacent PELIs to decide whether they
-make up a consistent enumerated list.
-
-If a PELI is labeled with a "1.", and is immediately followed by a
-PELI labeled with a "2.", we've got an enumerated list. Or "(A)"
-followed by "(B)". Or "i)" followed by "ii)", etc. The chances of
-accidentally recognizing two adjacent and consistently labeled PELIs,
-are acceptably small.
-
-For an enumerated list to be recognized, the following must be true:
-
-- the list must consist of multiple adjacent list items (2 or more)
-- the enumerators must all have the same format
-- the enumerators must be sequential
-
+Rather, the parser should recognize a variety of enumerator styles.
It is also recommended that the enumerator of the first list item be
ordinal-1 ('1', 'A', 'a', 'I', or 'i'), as output formats may not be
able to begin a list at an arbitrary enumeration.
+An initial idea was to require two or more consistent enumerated list
+items in a row. This idea proved impractical and was dropped. In
+practice, the presence of a proper enumerator is enough to reliably
+recognize an enumerated list item; any ambiguities are reported by the
+parser. Here's the original idea for posterity:
+
+ The parser should recognize a variety of enumerator styles, mark
+ each block as a potential enumerated list item (PELI), and
+ interpret the enumerators of adjacent PELIs to decide whether they
+ make up a consistent enumerated list.
+
+ If a PELI is labeled with a "1.", and is immediately followed by a
+ PELI labeled with a "2.", we've got an enumerated list. Or "(A)"
+ followed by "(B)". Or "i)" followed by "ii)", etc. The chances
+ of accidentally recognizing two adjacent and consistently labeled
+ PELIs, are acceptably small.
+
+ For an enumerated list to be recognized, the following must be
+ true:
+
+ - the list must consist of multiple adjacent list items (2 or
+ more)
+ - the enumerators must all have the same format
+ - the enumerators must be sequential
+
Definition List Markup
======================