Suggestions from @tocic:
<changes> — <reason> — <automatable>:
- use ``` instead of
for code blocks (even inside quotes) — easier to read/write, code highlighting — greppable
- no
using namespace std; — more vertical space — clang-tidy/greppable
- no EOL at EOF — consistency —
clang-format can consistently do the opposite
- 2 or 4 spaces for code indentation — consistency, more horizontal space —
clang-format
(...) for omitting, [some text] for our remarks inside references — consistency — not
*/** instead of _/__ — consistency, to support _ in refs — not
https instead of http — security — greppable
- strip whitespace — easier to read —
git
- remove/replace non-printable chars — looks like they are present in the original standard draft so we can ignore them in the future — greppable
- add missing punctuation — consistency, easier to read — partially greppable
- use
> instead of "" for refs — easier to read, better highlighting — not
- empty line before a quote — consistency, easier to read in long explanations — greppable
> instead of just > — consistency, easier to read — greppable
- use
> (right angle bracket + newline) for linebreaks in quotes — vanilla markdown syntax, idk why it renders correctly without them — not
- try to preserve the original formatting in quotes — hightlighting, easier to match — not
- always add a hint — if there's "No hint", the user loses his score for nothing — greppable
- refer to
¶note-X and ¶general-example-Y directly where appropriate — no need to write [*Note X*: and — *end example*] — not
Suggestions from @tocic:
<changes> — <reason> — <automatable>:
for code blocks (even inside quotes) — easier to read/write, code highlighting — greppableusing namespace std;— more vertical space —clang-tidy/greppableclang-formatcan consistently do the oppositeclang-format(...)for omitting,[some text]for our remarks inside references — consistency — not*/**instead of_/__— consistency, to support_in refs — nothttpsinstead ofhttp— security — greppablegit>instead of""for refs — easier to read, better highlighting — not>instead of just>— consistency, easier to read — greppable>(right angle bracket + newline) for linebreaks in quotes — vanilla markdown syntax, idk why it renders correctly without them — not¶note-Xand¶general-example-Ydirectly where appropriate — no need to write[*Note X*:and— *end example*]— not