[tor-bugs] #28615 [Metrics/Library]: Additional @type annotation

[Tor Bug Tracker & Wiki]

#28615: Additional @type annotation
-----------------------------+------------------------------
 Reporter:  atagar           |          Owner:  metrics-team
     Type:  enhancement      |         Status:  new
 Priority:  Medium           |      Milestone:
Component:  Metrics/Library  |        Version:
 Severity:  Normal           |     Resolution:
 Keywords:                   |  Actual Points:
Parent ID:                   |         Points:
 Reviewer:                   |        Sponsor:
-----------------------------+------------------------------

Comment (by teor):

 Replying to [comment:8 juga]:
 > Replying to [comment:7 atagar]:
 > > > What do you suggest as @type annotation for bandwidth files?
 > >
 > > Perfect question, and something I intentionally neglected to mention
 because I don't know for certain. The spec uses the terms 'bandwidth file'
 or 'bandwidth list', and in Stem I opted to call the class a
 BandwidthMetric. Adding juga and teor to this ticket to see if they have
 an opinion on which they want...
 > >
 > > {{{
 > > @type bandwidth 1.2
 > > @type bandwidth-file 1.2
 > > @type bandwidth-list 1.2
 > > @type bandwidth-metric 1.2
 > > }}}
 > >
 > > **juga, teor: any preference on which of the above you like best?**
 >
 > I think it should be `bandwidth-file`.

 +1, to match https://gitweb.torproject.org/torspec.git/tree/bandwidth-
 file-spec.txt

 > Actually re-reading the spec, i think it's a bug that we use `Bandwidth
 List` to refer to the whole content of the file, `Bandwidth List` should
 be used only for the body, ie the list of relays' measurements.

 +1, it would be nice to fix, but I think the spec still makes sense

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