cppquiz
cppquiz copied to clipboard
Add guidelines for formatting questions and explanations
Suggestions from @tocic:
<changes> — <reason> — <automatable>:
- use ``` instead of
- 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 ofhttp
— 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