[Checkins] SVN: z3c.pt/trunk/src/z3c/pt/generation.py Added a comment, explaining the call signature

[Hanno Schlichting]

Log message for revision 88469:
  Added a comment, explaining the call signature

Changed:
  U   z3c.pt/trunk/src/z3c/pt/generation.py

-=-
Modified: z3c.pt/trunk/src/z3c/pt/generation.py
===================================================================
--- z3c.pt/trunk/src/z3c/pt/generation.py	2008-07-18 07:34:25 UTC (rev 88468)
+++ z3c.pt/trunk/src/z3c/pt/generation.py	2008-07-18 07:48:05 UTC (rev 88469)
@@ -46,7 +46,10 @@
     return negotiate(context)
 
 def _escape(s, quote=0, string=1):
-    """Replace special characters '&', '<' and '>' by SGML entities."""
+    """Replace special characters '&', '<' and '>' by SGML entities.
+
+    If string is set to False, we are dealing with Unicode input.
+    """
     if string:
         s = str(s)
     if '&' in s: