Commit 37a0024
committed
QA/Markdown CS: various tweaks
* Code snippets which either _look like markdown_ or could confuse markdown parsers, should be wrapped in backticks.
* Text in square brackets, which is not a link, should escape the square brackets.
* Various (tooling) names should use proper case, except when used in code snippets.
To that end, either fix the case of the term or wrap the code snippet in backticks.
* No blank line within lists.
* No trailing spaces.
Note: especially in the CHANGELOG file, there is a lot more text which should be wrapped in backticks, but that's outside the scope of this current PR, which is aimed at one the one hand preventing markdown parsing problems and on the other hand allowing to run an automated Markdownlint check via CI.1 parent 15e1f09 commit 37a0024
File tree
3 files changed
+83
-85
lines changed- .github
3 files changed
+83
-85
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
339 | 339 | | |
340 | 340 | | |
341 | 341 | | |
342 | | - | |
| 342 | + | |
343 | 343 | | |
344 | 344 | | |
345 | 345 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
0 commit comments