#26124 closed Cleanup/optimization (fixed)
Add missing code formatting in docs headers
| Reported by: | Tim Graham | Owned by: | Rowan |
|---|---|---|---|
| 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!
Attachments (1)
Change History (13)
Changed 8 years ago by
| Attachment: | 26124.diff added |
|---|
comment:1 Changed 8 years ago by
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:2 Changed 8 years ago by
comment:3 Changed 8 years ago by
| 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.
comment:4 follow-up: 5 Changed 8 years ago by
| Owner: | changed from nobody to Rowan |
|---|---|
| Status: | new → assigned |
comment:5 follow-up: 6 Changed 8 years ago by
Replying to rowanv:
Created branch with the requested changes. Work is available at ticket_26124 branch here: https://github.com/rowanv/django/tree/ticket_26124 .
Built the documentation and got 4 warnings, but these are the same ones that I got from building master's documentation:
/Users/rowan/workspace/django/docs/topics/i18n/translation.txt:309: WARNING: Could not parse literal_block as "po". highlighting skipped. /Users/rowan/workspace/django/docs/topics/i18n/translation.txt:1246: WARNING: Could not parse literal_block as "json". highlighting skipped. /Users/rowan/workspace/django/docs/topics/i18n/translation.txt:1546: WARNING: Could not parse literal_block as "javascript". highlighting skipped. /Users/rowan/workspace/django/docs/topics/security.txt:32: WARNING: Could not parse literal_block as "html+django". highlighting skipped.
Created pull request.
comment:6 Changed 8 years ago by
Jenkins build failed due to added indentation at ref/files/uploads.txt
Fixed and squashed into original commit, pushed to ticket_26124 branch.
comment:7 Changed 8 years ago by
| Has patch: | set |
|---|
comment:8 Changed 8 years ago by
| Patch needs improvement: | set |
|---|
Left comments for improvement on the pull request.
comment:9 Changed 8 years ago by
| Patch needs improvement: | unset |
|---|
Hii can you please explain me, I am unable to get what is need to be done.