[tor-commits] [bridgedb/develop] Add more info to docstring for `b.p.descriptors.parseBridgeExtraInfoFiles()`.

[isis@xxxxxxxxxxxxxx]

commit 1e4de24ac711dbcbe6b1992da951a90ee64c2e8e
Author: Isis Lovecruft <isis@xxxxxxxxxxxxxx>
Date:   Tue Aug 26 04:00:27 2014 +0000

    Add more info to docstring for `b.p.descriptors.parseBridgeExtraInfoFiles()`.
---
 lib/bridgedb/parse/descriptors.py |   10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/lib/bridgedb/parse/descriptors.py b/lib/bridgedb/parse/descriptors.py
index 939ecb0..ab0d37f 100644
--- a/lib/bridgedb/parse/descriptors.py
+++ b/lib/bridgedb/parse/descriptors.py
@@ -141,9 +141,15 @@ def deduplicate(descriptors):
 def parseBridgeExtraInfoFiles(*filenames, **kwargs):
     """Parse files which contain ``@type bridge-extrainfo-descriptor``s.
 
-    :kwargs: If there is a ``'validate'`` keyword argument, its value will be
-        passed along as the ``'validate'`` argument to
+    .. note:: This function will call :func:`deduplicate` to deduplicate the
+        extrainfo descriptors parsed from all **filenames**.
+
+    :kwargs validate: If there is a ``'validate'`` keyword argument, its value
+        will be passed along as the ``'validate'`` argument to
         :api:`stem.descriptor.extrainfo_descriptor.BridgeExtraInfoDescriptor`.
+    :rtype: dict
+    :returns: A dictionary mapping bridge fingerprints to deduplicated
+        :api:`stem.descriptor.extrainfo_descriptor.BridgeExtraInfoDescriptor`s.
     """
     descriptors = []
     descriptorType = 'bridge-extra-info 1.1'



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits