[Zope3-checkins] CVS: Packages/ZConfig/doc - zconfig.tex:1.29

[Fred L. Drake, Jr.]

Update of /cvs-repository/Packages/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv12139

Modified Files:
	zconfig.tex 
Log Message:
Be more strict when scanning the source text:  If '$' is not followed
by '$' or a name, raise an exception.  (Previously this used '' for
the replacement text.)


=== Packages/ZConfig/doc/zconfig.tex 1.28 => 1.29 ===
--- Packages/ZConfig/doc/zconfig.tex:1.28	Wed Dec  4 17:56:35 2002
+++ Packages/ZConfig/doc/zconfig.tex	Wed Dec  4 20:10:47 2002
@@ -637,7 +637,8 @@
 
 In each case, \var{name} is a non-empty sequence of alphanumeric and
 underscore characters not starting with a digit.  If there is not a
-replacement for \var{name}, an empty string is used.
+replacement for \var{name}, the exception
+\exception{SubstitutionReplacementError} is raised.
 Note that the lookup is expected to be case-insensitive; this module
 will always use a lower-case version of the name to perform the query.
 
@@ -657,12 +658,23 @@
   text, otherwise returns \code{False}.
 \end{funcdesc}
 
-The following exception is defined:
+The following exceptions are defined:
+
+\begin{excdesc}{SubstitutionError}
+  Base class for the specific exceptions raised by this module.
+  Instances provide the attribute \member{message}, which contains a
+  description of the error.
+\end{excdesc}
+
+\begin{excdesc}{SubstitutionReplacementError}
+  Raised when the source text contains references to names which are
+  not defined in \var{mapping}.  The attributes \member{source} and
+  \member{name} provide the complete source text and the name
+  (converted to lower case) for which no replacement is defined.
+\end{excdesc}
 
 \begin{excdesc}{SubstitutionSyntaxError}
-  Raised when the source text contains syntactical errors.  Instances
-  provide the attribute \member{message}, which contains a description
-  of the error.
+  Raised when the source text contains syntactical errors.
 \end{excdesc}