summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamian Johnson <atagar@torproject.org>2016-10-29 15:39:23 -0700
committerDamian Johnson <atagar@torproject.org>2016-10-29 15:39:23 -0700
commitaec24a2c3ca5bf74dec3b1390e4dd69a93972028 (patch)
treecb5c38d844ed7136cb3e9707836d3ff533d4824f
parent8ce3fc16bb108208e57ffad9d723f9b2bf9e1cab (diff)
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
-rw-r--r--stem/descriptor/router_status_entry.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/stem/descriptor/router_status_entry.py b/stem/descriptor/router_status_entry.py
index cc6c659a..bf146a98 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