[Docutils-checkins] r6994 - trunk/docutils/docs/ref/rst/restructuredtext.txt

[<mi...@us...>]

Author: milde
Date: 2011-03-21 12:44:27 +0100 (Mon, 21 Mar 2011)
New Revision: 6994

Modified:
   trunk/docutils/docs/ref/rst/restructuredtext.txt
Log:
Documentation fix: Allowed characters in directive types and role names.

The simplename regular expression allows also internal plus signs and colons
(docutils/parsers/rst/states.py:544).

Thanks to Stefan Merten to reporting this inconsistency.

Modified: trunk/docutils/docs/ref/rst/restructuredtext.txt
===================================================================
--- trunk/docutils/docs/ref/rst/restructuredtext.txt	2011-03-20 17:20:36 UTC (rev 6993)
+++ trunk/docutils/docs/ref/rst/restructuredtext.txt	2011-03-21 11:44:27 UTC (rev 6994)
@@ -1989,9 +1989,9 @@
 Directives are indicated by an explicit markup start (".. ") followed
 by the directive type, two colons, and whitespace (together called the
 "directive marker").  Directive types are case-insensitive single
-words (alphanumerics plus internal hyphens, underscores, and periods;
-no whitespace).  Two colons are used after the directive type for
-these reasons:
+words (alphanumerics plus isolated internal hyphens, underscores,
+plus signs, colons, and periods; no whitespace).  Two colons are used
+after the directive type for these reasons:
 
 - Two colons are distinctive, and unlikely to be used in common text.
 
@@ -2567,10 +2567,11 @@
 interpreted.  The role may be inferred implicitly (as above; the
 "default role" is used) or indicated explicitly, using a role marker.
 A role marker consists of a colon, the role name, and another colon.
-A role name is a single word consisting of alphanumerics plus internal
-hyphens, underscores, and periods; no whitespace or other characters
-are allowed.  A role marker is either a prefix or a suffix to the
-interpreted text, whichever reads better; it's up to the author::
+A role name is a single word consisting of alphanumerics plus isolated
+internal hyphens, underscores, plus signs, colons, and periods;
+no whitespace or other characters are allowed.  A role marker is
+either a prefix or a suffix to the interpreted text, whichever reads
+better; it's up to the author::
 
     :role:`interpreted text`