[tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
-----------------------------------+------------------------------------
 Reporter:  nickm                  |          Owner:  nickm
     Type:  task                   |         Status:  needs_information
 Priority:  Medium                 |      Milestone:  Tor: 0.4.4.x-final
Component:  Core Tor/Tor           |        Version:
 Severity:  Normal                 |     Resolution:
 Keywords:  doc, s31-docs 042-can  |  Actual Points:  0.9
Parent ID:                         |         Points:  1
 Reviewer:  asn                    |        Sponsor:
-----------------------------------+------------------------------------
Changes (by asn):

 * status:  needs_review => needs_information


Comment:

 I'm inclined to NACK this branch. I think such a big list of abbreviations
 will be hard to maintain and use both for us and for volunteers. Also I
 feel like the benefit does not outweight the overhead of enforcing the
 abbreviations and checking whether an abbreviation exists everytime you
 want to write code.

 Perhaps as a way to do short-term progress here would be to identify a
 bunch of important abbreviations that we get wrong often and fix those.

 And then if in the future this abbreviation inconsistency issue becomes a
 problem, we can revisit the list from comment:13 and see how to make it
 useful.

 Or we can ignore this ticket for now (which honestly would be my
 approach).

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