[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
Re: [tor-bugs] #31943 [Core Tor/Tor]: Review pull request: reorganized Tor manual
#31943: Review pull request: reorganized Tor manual
---------------------------------+------------------------------------
Reporter: swati | Owner: swati
Type: enhancement | Status: needs_review
Priority: Medium | Milestone: Tor: 0.4.3.x-final
Component: Core Tor/Tor | Version:
Severity: Normal | Resolution:
Keywords: gsod, documentation | Actual Points:
Parent ID: | Points:
Reviewer: catalyst | Sponsor:
---------------------------------+------------------------------------
Comment (by catalyst):
Thanks for contributing these changes! I've taken most of the changes to
the FILES, SEE ALSO, and BUGS sections and put them in a separate ticket,
#32176. We can work on incorporating your other changes once we have that
merged.
Generally, we tend to use imperative tense when describing things like
command line options. (We also use imperative tense when documenting what
C functions do.) For example, we prefer "Specify a file..." to "Specifies
a file...". If we're not consistently using imperative tense for command
line options, it might be better to fix the exceptions rather than change
everything else to not use the imperative. What do you think?
I did notice that somehow the changes in
e5cf1423fdc1707093885e5d74f0691de3365b55 got reverted in your patch. I
think it would be good for us to understand how that happened. Please feel
free to reach out to me or ahf for help with that if you need.
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/31943#comment:11>
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