Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#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 Tim Graham)

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)

26124.diff (1.7 KB ) - added by Tim Graham 8 years ago.

Download all attachments as: .zip

Change History (13)

by Tim Graham, 8 years ago

Attachment: 26124.diff added

comment:1 by Tim Graham, 8 years ago

Triage Stage: UnreviewedAccepted

comment:2 by Mahendra Yadav, 8 years ago

Hii can you please explain me, I am unable to get what is need to be done.

comment:3 by Tim Graham, 8 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.

comment:4 by Rowan, 8 years ago

Owner: changed from nobody to Rowan
Status: newassigned

in reply to:  4 ; comment:5 by Rowan, 8 years ago

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.

in reply to:  5 comment:6 by Rowan, 8 years ago

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 by Tim Graham, 8 years ago

Has patch: set

comment:8 by Tim Graham, 8 years ago

Patch needs improvement: set

Left comments for improvement on the pull request.

comment:9 by Rowan, 8 years ago

Patch needs improvement: unset

comment:10 by Rowan, 8 years ago

Submitted requested changes, updated pull request

comment:11 by Tim Graham <timograham@…>, 8 years ago

Resolution: fixed
Status: assignedclosed

In a6ef025:

Fixed #26124 -- Added missing code formatting to docs headers.

comment:12 by Tim Graham <timograham@…>, 8 years ago

In a9fbf073:

[1.9.x] Fixed #26124 -- Added missing code formatting to docs headers.

Backport of a6ef025dfb2a1d1bd23893408eef6d066fb506d9 from master

Note: See TracTickets for help on using tickets.
Back to Top