From: Felix Schwarz Date: Sat, 3 Sep 2011 08:31:43 +0000 (+0000) Subject: fix docstring for babel.messages.extract() so it mentions the correct return type X-Git-Tag: 1.0~187 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=da0a1317e02acf0b26a25a44ce82b61310feeae1;p=thirdparty%2Fbabel.git 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 index 54ad4ab4..7805ee62 100644 --- a/babel/messages/extract.py +++ b/babel/messages/extract.py @@ -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