[tor-bugs] #29715 [Core Tor/Stem]: Change documentation about RouterStatusEntryV3 bandwidth to specify that unit is kilobytes

[Tor Bug Tracker & Wiki]

#29715: Change documentation about RouterStatusEntryV3 bandwidth to specify that
unit is kilobytes
---------------------------+------------------------
 Reporter:  juga           |          Owner:  atagar
     Type:  defect         |         Status:  new
 Priority:  Medium         |      Milestone:
Component:  Core Tor/Stem  |        Version:
 Severity:  Normal         |     Resolution:
 Keywords:                 |  Actual Points:
Parent ID:                 |         Points:
 Reviewer:                 |        Sponsor:
---------------------------+------------------------

Old description:

> In
> https://github.com/torproject/stem/blob/master/stem/descriptor/router_status_entry.py#L553
> it says that it is `unit-less`, but i think it is not completely right.
> Tor code uses kilobytes:
> htps://github.com/torproject/tor/blob/master/src/feature/dirauth/bwauth.c#L191,
> https://github.com/torproject/torspec/blob/master/dir-spec.txt#L2387,
> https://github.com/torproject/tor/blob/master/src/feature/dirauth/dirvote.c#L2303.
> sbws and Torflow also divide by 1000 after scaling (which changes orders
> of magnitude):
> https://github.com/torproject/sbws/blob/master/sbws/lib/v3bwfile.py#L175

New description:

 In
 https://github.com/torproject/stem/blob/master/stem/descriptor/router_status_entry.py#L553
 it says that it is `unit-less`, but i think it is not completely right.
 Tor code uses kilobytes:
 https://github.com/torproject/tor/blob/master/src/feature/dirauth/bwauth.c#L191,
 https://github.com/torproject/torspec/blob/master/dir-spec.txt#L2387,
 https://github.com/torproject/tor/blob/master/src/feature/dirauth/dirvote.c#L2303.
 sbws and Torflow also divide by 1000 after scaling (which changes orders
 of magnitude):
 https://github.com/torproject/sbws/blob/master/sbws/lib/v3bwfile.py#L175

--

Comment (by teor):

 Fix url

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/29715#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online