[tor-commits] [stem/master] Clarifying the router status entry's 'measured' metric

[atagar at torproject.org]

commit dd748efb9974f23fb6e70fe0c598e35dcfbbee43
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon Nov 24 12:07:31 2014 -0800

    Clarifying the router status entry's 'measured' metric
    
    Anna's first question on irc was 'what are the units? kb/s?'. This is a fine
    question since both we and the Tor spec are sparse on details here. Adding a
    little clarification on what this attribute means.
---
 stem/descriptor/router_status_entry.py |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/stem/descriptor/router_status_entry.py b/stem/descriptor/router_status_entry.py
index 3dd9026..90d704c 100644
--- a/stem/descriptor/router_status_entry.py
+++ b/stem/descriptor/router_status_entry.py
@@ -313,7 +313,9 @@ class RouterStatusEntryV3(RouterStatusEntry):
   :var str digest: **\*** router's upper-case hex digest
 
   :var int bandwidth: bandwidth claimed by the relay (in kb/s)
-  :var int measured: bandwidth measured to be available by the relay
+  :var int measured: bandwidth measured to be available by the relay, this is a
+    unit-less heuristic generated by the Bandwidth authoritites to weight relay
+    selection
   :var bool is_unmeasured: bandwidth measurement isn't based on three or more
     measurements
   :var list unrecognized_bandwidth_entries: **\*** bandwidth weighting