[tor-commits] [stem/master] Correct docs about router status entry bandwidths

[atagar at torproject.org]

commit aec24a2c3ca5bf74dec3b1390e4dd69a93972028
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Oct 29 15:39:23 2016 -0700

    Correct docs about router status entry bandwidths
    
    Good point from Tom that our docs around this are wrong...
    
      https://trac.torproject.org/projects/tor/ticket/20493
      https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt#n2012
---
 stem/descriptor/router_status_entry.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/stem/descriptor/router_status_entry.py b/stem/descriptor/router_status_entry.py
index cc6c659..bf146a9 100644
--- a/stem/descriptor/router_status_entry.py
+++ b/stem/descriptor/router_status_entry.py
@@ -550,11 +550,11 @@ class RouterStatusEntryV3(RouterStatusEntry):
   :var str identifier: base64 encoded identity digest
   :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, this is a
+  :var int bandwidth: 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
+  :var int measured: *bandwidth* vote provided by a bandwidth authority
+  :var bool is_unmeasured: *bandwidth* measurement isn't based on three or more
     measurements
   :var list unrecognized_bandwidth_entries: **\*** bandwidth weighting
     information that isn't yet recognized