Draft: Convert coding guidelines to markdown
Compare changes
Some changes are not shown
For a faster browsing experience, some files are collapsed by default.
Files
6+ 0
− 0
atlas_cpp_guidelines.pdf
DownloadExperimental migration of the C++ coding guidelines (by @ssnyder) from the original org-format [1] to markdown. Mostly done using pandoc
and few extra fixes using sed
(see full command below).
Comparison:
TODO (in case we decide to make this our primary source for the coding guidelines)
[1] https://gitlab.cern.ch/ssnyder/coding-rules/-/blob/master/rules.org
cat rules.org |
# Convert example code blocks to proper C++ code blocks
sed 's/BEGIN_EXAMPLE/BEGIN_SRC cpp/' | sed 's/END_EXAMPLE/END_SRC/' |
# Convert to markdown
pandoc --shift-heading-level-by=1 --from=org --to=markdown_strict+backtick_code_blocks+footnotes |
# Fix double quotes
sed 's/\\`\\`/"/g' | sed "s/''/\"/g" |
# Create proper anchors
sed 's/\\\[<span id="\(.*\)"><\/span>\\\]/[[\1]](#\1){: #\1}/' > rules.md
For a faster browsing experience, some files are collapsed by default.
atlas_cpp_guidelines.pdf
Download