From: W. Trevor King <wking@drexel.edu>
Date: Fri, 23 Apr 2010 00:39:48 +0000 (-0400)
Subject: Add docstring to SCons.Scanner.LaTeX.canonical_text
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=da4e44acf75646440e92d2f7e57dcb5f481be794;p=scons.git

Add docstring to SCons.Scanner.LaTeX.canonical_text
---

diff --git a/src/engine/SCons/Scanner/LaTeX.py b/src/engine/SCons/Scanner/LaTeX.py
index f43b19cf..6969d2be 100644
--- a/src/engine/SCons/Scanner/LaTeX.py
+++ b/src/engine/SCons/Scanner/LaTeX.py
@@ -281,6 +281,11 @@ class LaTeX(SCons.Scanner.Base):
         return i, include
 
     def canonical_text(self, text):
+        """Standardize an input TeX-file contents.
+
+        Currently:
+          * removes comments, unwrapping comment-wrapped lines.
+        """
         out = []
         line_continues_a_comment = False
         for line in text.splitlines():