# HG changeset patch # User fschwarz # Date 1315038703 0 # Node ID 86524be05b60b8e25b5d2448279f640e35bc6381 # Parent 8831b754f81e01720eb2c6618b690b405b5e79d4 fix docstring for babel.messages.extract() so it mentions the correct return type diff --git a/babel/messages/extract.py b/babel/messages/extract.py --- a/babel/messages/extract.py +++ b/babel/messages/extract.py @@ -204,7 +204,7 @@ """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 @@ :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