From: W. Trevor King <wking@drexel.edu>
Date: Fri, 23 Apr 2010 00:36:23 +0000 (-0400)
Subject: Oops.  Correct docstring for multi-line_include_options.py
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=7fc9e89612088ec9102431d9b1b783ab3005b7a0;p=scons.git

Oops.  Correct docstring for multi-line_include_options.py
---

diff --git a/test/TEX/multi-line_include_options.py b/test/TEX/multi-line_include_options.py
index bd214c7b..33e7a391 100644
--- a/test/TEX/multi-line_include_options.py
+++ b/test/TEX/multi-line_include_options.py
@@ -25,13 +25,14 @@
 __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