Opened 9 years ago
Last modified 9 years ago
#26124 closed Cleanup/optimization
Add missing code formatting in docs headers — at Version 3
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 (last modified by )
Some docs headers are missing backticks for code entities (referred in that sphinx doc as backquotes).
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!
Change History (4)
by , 9 years ago
Attachment: | 26124.diff added |
---|
comment:1 by , 9 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 9 years ago
comment:3 by , 9 years ago
Description: | modified (diff) |
---|
Did you look at the sample patch? I added a link in the ticket description to the reStructuredText Primer -- maybe that will help. I don't think I can explain the task any more simply.
Hii can you please explain me, I am unable to get what is need to be done.