[tor-commits] [sbws/master] scanner: add docstring to measure_relay

[juga at torproject.org]

commit df5ccb0997dddff925c1d4548c504a50377cb8c0
Author: juga0 <juga at riseup.net>
Date:   Thu Feb 7 12:50:40 2019 +0000

    scanner: add docstring to measure_relay
    
    Closes: #29149. Bugfix v0.1.0.
---
 sbws/core/scanner.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/sbws/core/scanner.py b/sbws/core/scanner.py
index 013d4ee..3d98c55 100644
--- a/sbws/core/scanner.py
+++ b/sbws/core/scanner.py
@@ -231,6 +231,13 @@ def _pick_ideal_second_hop(relay, dest, rl, cont, is_exit):
 
 
 def measure_relay(args, conf, destinations, cb, rl, relay):
+    """
+    Select a Web server, a relay to build the circuit,
+    build the circuit and measure the bandwidth of the given relay.
+
+    :return Result: a measurement Result object
+
+    """
     log.debug('Measuring %s %s', relay.nickname, relay.fingerprint)
     s = requests_utils.make_session(
         cb.controller, conf.getfloat('general', 'http_timeout'))