]> git.ipfire.org Git - thirdparty/babel.git/commitdiff
fix docstring for babel.messages.extract() so it mentions the correct return type
authorFelix Schwarz <felix.schwarz@oss.schwarz.eu>
Sat, 3 Sep 2011 08:31:43 +0000 (08:31 +0000)
committerFelix Schwarz <felix.schwarz@oss.schwarz.eu>
Sat, 3 Sep 2011 08:31:43 +0000 (08:31 +0000)
babel/messages/extract.py

index 54ad4ab4c9696f872593990c56d65aec9ff3e3cd..7805ee6255df9196cfd4359c20ada4e56465eb01 100644 (file)
@@ -204,7 +204,7 @@ def extract(method, fileobj, keywords=DEFAULT_KEYWORDS, comment_tags=(),
     """Extract messages from the given file-like object using the specified
     extraction method.
 
-    This function returns a list of tuples of the form:
+    This function returns tuples of the form:
 
         ``(lineno, message, comments)``
 
@@ -237,8 +237,8 @@ def extract(method, fileobj, keywords=DEFAULT_KEYWORDS, comment_tags=(),
     :param options: a dictionary of additional options (optional)
     :param strip_comment_tags: a flag that if set to `True` causes all comment
                                tags to be removed from the collected comments.
-    :return: the list of extracted messages
-    :rtype: `list`
+    :return: an iterator over ``(lineno, message, comments)`` tuples
+    :rtype: `iterator`
     :raise ValueError: if the extraction method is not registered
     """
     func = None