[tor-commits] [stem/master] Document unit for consensus bandwidth fields

[atagar@xxxxxxxxxxxxxx]

commit b8f1be536258fc4f47c3311931a2dea52ab2c335
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date:   Thu May 9 09:49:46 2019 -0700

    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
---
 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 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

_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits