[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
Re: [tor-bugs] #33688 [Core Tor/Tor]: README cleanups
#33688: README cleanups
--------------------------+------------------------------------
Reporter: bduszel | Owner: (none)
Type: enhancement | Status: needs_revision
Priority: Very Low | Milestone: Tor: 0.4.4.x-final
Component: Core Tor/Tor | Version:
Severity: Minor | Resolution:
Keywords: doc | Actual Points:
Parent ID: | Points:
Reviewer: catalyst | Sponsor:
--------------------------+------------------------------------
Changes (by catalyst):
* status: needs_review => needs_revision
Comment:
Thanks for the patch! It mostly looks good. I have a few minor comments:
We don't consistently use the `.../doc/HACKING` reference style to refer
to locations in the source tree. I'm not sure if we want to adopt it. Is
that a syntax that some other markdown language treats specially? I think
the best alternative might be to make all pathname references be relative
to the top of the source tree, e.g., `doc/HACKING` instead of
`.../doc/HACKING`.
The "underline" of the section headings should be the same length as the
title. After your patch, some of them are longer than their corresponding
title strings. (Some of them were already longer, though.) Alternatively,
we could move toward using the `## Section name` style, which doesn't
require variable-length underlines.
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/33688#comment:7>
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