Oops. Correct docstring for multi-line_include_options.py
authorW. Trevor King <wking@drexel.edu>
Fri, 23 Apr 2010 00:36:23 +0000 (20:36 -0400)
committerW. Trevor King <wking@drexel.edu>
Fri, 23 Apr 2010 00:36:23 +0000 (20:36 -0400)
test/TEX/multi-line_include_options.py

index bd214c7bb0acea39ff4835b4b11cda7ed8d3fe7c..33e7a391031ed142bc4435581cdf9ffbc78a0a84 100644 (file)
 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 
 """
-This is an obscure test case. When
-  1) a file without a suffix is included in a TeX build and
-  2) there is a directory with the same name as that file,
-verify that a TypeError is not thrown upon trying to recursively scan
-the contents of includes. The TypeError indicates that the directory
-with the same name was trying to be scanned as the include file, which
-it clearly is not.
+When an inclusion's optional argument (enclosed in square brackets:
+[]) spans multiple lines (via comment wrapping), ensure that the LaTeX
+Scanner doesn't throw an IndexError.
+
+An example of this in the wild is in Thomas Heim's epsdice LaTeX package:
+  \includegraphics[height=1.75ex,viewport= 3 4 38 39,%
+  clip=true]{\dicefile}%
+In epsdice 2007/02/15, v. 2.1.
 """
 
 import TestSCons