Opened 9 years ago
Last modified 9 years ago
#26124 closed Cleanup/optimization
Add missing code formatting in docs headers — at Initial Version
| Reported by: | Tim Graham | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
Some docs headers are missing backticks for code entities.
I've attached the start of a patch to give an idea of what to do. I only started the modified files, so please check the rest of those files as well as all other files.
I think we should also remove links (as in docs/topics/performance.txt, for example) from headers as the formatting doesn't look good across all formats and the links should be repeated in the content that follows the header anyway.
While reviewing the headers, it would be a good opportunity to also remove any extra blank lines between sections (we always use 1 blank line between sections) or add any missing blank lines.
If you have any questions, just leave a comment. Thanks!