Mercurial > babel > mirror
changeset 560:86524be05b60 trunk
fix docstring for babel.messages.extract() so it mentions the correct return type
| author | fschwarz |
|---|---|
| date | Sat, 03 Sep 2011 08:31:43 +0000 |
| parents | 8831b754f81e |
| children | 7c81bb0d32e5 |
| files | babel/messages/extract.py |
| diffstat | 1 files changed, 3 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- 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