changeset 84:3c6421bca777

Missed some param's documentation regarding translator comments.
author palgarvio
date Sun, 10 Jun 2007 16:46:55 +0000
parents 80e895a498a3
children e10f82c1d4c4
files babel/messages/extract.py
diffstat 1 files changed, 11 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/babel/messages/extract.py
+++ b/babel/messages/extract.py
@@ -55,7 +55,7 @@
     
     This function generates tuples of the form:
     
-        ``(filename, lineno, message)``
+        ``(filename, lineno, message, comments)``
     
     Which extraction method is used per file is determined by the `method_map`
     parameter, which maps extended glob patterns to extraction method names.
@@ -106,6 +106,8 @@
                      that should be recognized as translation functions) to
                      tuples that specify which of their arguments contain
                      localizable strings
+    :param comments_tags: a list of translator tags to search for and include
+                          in output
     :param callback: a function that is called for every file that message are
                      extracted from, just before the extraction itself is
                      performed; the function is passed the filename, the name
@@ -159,6 +161,8 @@
                      that should be recognized as translation functions) to
                      tuples that specify which of their arguments contain
                      localizable strings
+    :param comments_tags: a list of translator tags to search for and include
+                          in output
     :param options: a dictionary of additional options (optional)
     :return: the list of extracted messages
     :rtype: `list`
@@ -198,8 +202,8 @@
                      that should be recognized as translation functions) to
                      tuples that specify which of their arguments contain
                      localizable strings
-    :param comments_tags: a list of translator tags to search for and include in
-                          output
+    :param comments_tags: a list of translator tags to search for and include
+                          in output
     :param options: a dictionary of additional options (optional)
     :return: the list of extracted messages
     :rtype: `list`
@@ -239,8 +243,8 @@
     :param fileobj: the file-like object the messages should be extracted from
     :param keywords: a list of keywords (i.e. function names) that should be
                      recognized as translation functions
-    :param comments_tags: a list of translator tags to search for and include in
-                          output
+    :param comments_tags: a list of translator tags to search for and include
+                          in output
     :param options: a dictionary of additional options (optional)
     :return: an iterator over ``(lineno, funcname, message, comments)`` tuples
     :rtype: ``iterator``
@@ -274,8 +278,8 @@
     :param fileobj: the file-like object the messages should be extracted from
     :param keywords: a list of keywords (i.e. function names) that should be
                      recognized as translation functions
-    :param comments_tags: a list of translator tags to search for and include in
-                          output
+    :param comments_tags: a list of translator tags to search for and include
+                          in output
     :param options: a dictionary of additional options (optional)
     :return: an iterator over ``(lineno, funcname, message, comments)`` tuples
     :rtype: ``iterator``
Copyright (C) 2012-2017 Edgewall Software