[tor-bugs] #9655 [Website]: Tor manual's config default options could be clearer

["Tor Bug Tracker & Wiki" <blackhole@xxxxxxxxxxxxxx>]

#9655: Tor manual's config default options could be clearer
-------------------------+---------------------
 Reporter:  Ry           |          Owner:
     Type:  enhancement  |         Status:  new
 Priority:  trivial      |      Milestone:
Component:  Website      |        Version:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
-------------------------+---------------------
 Currently the default value for an option is suffixed on the description
 body, e.g.

  '''!UseMicrodescriptors'''Â'''0'''|'''1'''|'''auto''':: Microdescriptors
 are a smaller version of the information that Tor needs in order to build
 its circuits. Using microdescriptors makes Tor clients download less
 directory information, thus saving bandwidth. Directory caches need to
 fetch regular descriptors and microdescriptors, so this option doesnât
 save any bandwidth for them. If this option is set to "auto" (recommended)
 then it is on for all clients that do not set !FetchUselessDescriptors.
 (Default: auto)

 If you read this example it reads as ifÂFetchUselessDescriptiorsÂis
 defaulted to auto (It's actually defaulted to zero)Âwhen it actually means
 to show thatÂUseMicrodescriptorsÂdefaults to auto.

 I think it would be clearer if the default was clearly seperated from the
 description body, maybe as a subheader for each option.

-- 
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/9655>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs