[tor-commits] [bridgedb/master] Move Bridges.getConfigLine() documentation into function docstring.

[isis@xxxxxxxxxxxxxx]

commit bd526bf5a007d923b11337f4987153a8983ca0f7
Author: Isis Lovecruft <isis@xxxxxxxxxxxxxx>
Date:   Tue Dec 10 11:17:57 2013 +0000

    Move Bridges.getConfigLine() documentation into function docstring.
---
 lib/bridgedb/Bridges.py |   17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py
index a99860b..e27c287 100644
--- a/lib/bridgedb/Bridges.py
+++ b/lib/bridgedb/Bridges.py
@@ -150,13 +150,16 @@ class Bridge:
 
     def getConfigLine(self, includeFingerprint=False, addressClass=None,
             request=None, transport=None):
-        """Returns a valid bridge line for inclusion in a torrc"""
-        #arguments:
-        #    includeFingerprint
-        #    addressClass - type of address to choose 
-        #    request - a string unique to this request
-        #        e.g. email-address or uniformMap(ip)
-        #    transport - a pluggable transport method name
+        """Returns a valid bridge line for inclusion in a torrc.
+
+        :param bool includeFingerprint: If ``True``, include the
+            ``fingerprint`` of this :class:`Bridge` in the returned bridge
+            line.
+        :param DOCDOC addressClass: Type of address to choose.
+        :param str request: A string unique to this request e.g. email-address
+            or ``uniformMap(ip)`` or ``'default'``.
+        :param str transport: A pluggable transport method name.
+        """
 
         if not request: request = 'default'
         digest = get_hmac_fn('Order-Or-Addresses')(request)



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