summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamian Johnson <atagar@torproject.org>2019-05-09 09:49:46 -0700
committerDamian Johnson <atagar@torproject.org>2019-05-09 09:49:46 -0700
commitb8f1be536258fc4f47c3311931a2dea52ab2c335 (patch)
treeec6ca591334c775064dfbd87c2db3b731360e717
parent87cea952a27b024981e70efacc09253e22a7658f (diff)
Document unit for consensus bandwidth fields
My understanding is that bandwidth authority metrics were unit-less back in its TorFlow days (per discussions I had with Mike and Roger many years ago), but evidently this is no longer the case. Adopting the wording teor suggested... https://trac.torproject.org/projects/tor/ticket/29715
-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 321b1004..7d75d40d 100644
--- a/stem/descriptor/router_status_entry.py
+++ b/stem/descriptor/router_status_entry.py
@@ -549,9 +549,9 @@ class RouterStatusEntryV3(RouterStatusEntry):
:var str identifier: base64 encoded identity digest
:var str digest: **\*** router's upper-case hex digest
- :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 int bandwidth: bandwidth measured to be available by the relay, this is
+ an arbitrary units (currently kilobytes per second) heuristic generated by
+ the Bandwidth authoritites to weight relay selection
:var int measured: *bandwidth* vote provided by a bandwidth authority
:var bool is_unmeasured: *bandwidth* measurement isn't based on three or more
measurements