From 7f78995d06abd284f2595cdcd6333767e7adde56 Mon Sep 17 00:00:00 2001 From: David Bernard Date: Mon, 12 May 2014 12:04:16 +1000 Subject: [PATCH] Expand tag documentation to include syntax requirements --- CHANGES | 1 + doc/markup/misc.rst | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/CHANGES b/CHANGES index 7400c6440..02dda9455 100644 --- a/CHANGES +++ b/CHANGES @@ -142,6 +142,7 @@ Bugs fixed Documentation ------------- +* Add clarification about the syntax of tags. (:file:`doc/markup/misc.rst`) * #1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`) * Extended the :ref:`documentation about building extensions `. diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index b2e9051fd..2b069601f 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -189,6 +189,14 @@ Including content based on tags These standard tags are set *after* the configuration file is read, so they are not available there. + All tags must follow the standard Python identifier syntax as set out in + the `Identifiers and keywords + `_ + documentation. That is, a tag expression may only consist of tags that + conform to the syntax of Python variables. In ASCII, this consists of the + uppercase and lowercase letters ``A`` through ``Z``, the underscore ``_`` + and, except for the first character, the digits ``0`` through ``9``. + .. versionadded:: 0.6 .. versionchanged:: 1.2 Added the name of the builder and the prefixes.