[tor-commits] [bridgedb/master] Document the `fingerprint` parameter in networkstatus.parseALine().

[isis at torproject.org]

commit d3bd83103a28456bde1e2616145c927c266b0d54
Author: Isis Lovecruft <isis at torproject.org>
Date:   Fri Nov 22 01:13:21 2013 +0000

    Document the `fingerprint` parameter in networkstatus.parseALine().
---
 lib/bridgedb/parse/networkstatus.py |    4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lib/bridgedb/parse/networkstatus.py b/lib/bridgedb/parse/networkstatus.py
index 6e2c0d6..9f37ba6 100644
--- a/lib/bridgedb/parse/networkstatus.py
+++ b/lib/bridgedb/parse/networkstatus.py
@@ -170,6 +170,10 @@ def parseALine(line, fingerprint=None):
       |    consensus-method 14 or later.)
 
     :param string line: An 'a'-line from an bridge-network-status descriptor.
+    :type fingerprint: string or None
+    :param fingerprint: A string which identifies which OR the descriptor
+        we're parsing came from (since the 'a'-line doesn't tell us, this can
+        help make the log messages clearer).
     :raises: :exc:`NetworkstatusParsingError`
     :rtype: tuple
     :returns: A 2-tuple of a string respresenting the IP address and a