[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:
--------------------------+------------------------------------
Comment (by bduszel):
Thanks for the review catalyst.
I updated MR with your suggestions:
- references to the top of the source tree are updated (`doc/HACKING`
instead of `.../doc/HACKING`)
- underlines are replaced with `#` section marks, I tried to adjust
section levels along the way too
MR is the same. Please take a look when you will have a free minute or
two.
https://github.com/torproject/tor/pull/1832
----
I found some issues with code blocks in some *.md files (some files use
code blocks syntax, some do not). First of all, it's not consistent but
what's really bad is when *.md file is being displayed incorrectly. You
can find an example of what I'm saying in `CodingStandards.md` under `How
we log changes` section.
https://github.com/torproject/tor/blob/master/doc/HACKING/CodingStandards.md
#how-we-log-changes
Part of the git log output is still displayed as a regular text rather
than a formatted code block. I plan to check all code blocks under `doc`
directory later on (different ticket).
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/33688#comment:8>
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