Add docstring to SCons.Scanner.LaTeX.canonical_text

[scons.git] / src / engine / SCons / Scanner / LaTeX.py

diff --git a/src/engine/SCons/Scanner/LaTeX.py b/src/engine/SCons/Scanner/LaTeX.py
index f43b19cf4360a86a10139d74e7a7a87b20ba0b1a..6969d2be21848da5db0c254f49db73bbe5ae151f 100644 (file)
--- 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():