Add a docstring for parse_lintian_output

[dak.git] / daklib / lintian.py

diff --git a/daklib/lintian.py b/daklib/lintian.py
index fbd1bb7239af3f67d0b1a2625dfa46d04b1b0649..c0ee316a6e4a172e7690fd7a9991e73b04afe0ab 100644 (file)
--- a/daklib/lintian.py
+++ b/daklib/lintian.py
@@ -1,6 +1,13 @@
 from regexes import re_parse_lintian
 
 def parse_lintian_output(output):
+    """
+    Parses Lintian output and returns a generator with the data.
+
+    >>> list(parse_lintian_output('W: pkgname: some-tag path/to/file'))
+    [('W', 'pkgname', 'some-tag', 'path/to/file')]
+    """
+
     for line in output.split('\n'):
         m = re_parse_lintian.match(line)
         if m: