[Django] #26124: Add missing code formatting in docs headers
Django
------------------------------------------------+------------------------
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
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!
--
Ticket URL: <https://code.djangoproject.com/ticket/26124>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: timgraham | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timgraham):
* Attachment "26124.diff" added.
Django
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timgraham):
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:1>
Django
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by userimack):
Hii can you please explain me, I am unable to get what is need to be done.
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:2>
Django
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Old 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!
New description:
Some docs headers are missing [http://www.sphinx-
doc.org/en/stable/rest.html#inline-markup 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!
--
Comment (by timgraham):
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:3>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by rowanv):
* owner: nobody => rowanv
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:4>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by rowanv):
Replying to [comment:4 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.
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:5>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by rowanv):
Jenkins build failed due to added indentation at ref/files/uploads.txt
Fixed and squashed into original commit, pushed to ticket_26124 branch.
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:6>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timgraham):
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:7>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
Changes (by timgraham):
* needs_better_patch: 0 => 1
Comment:
Left comments for improvement on the
[https://github.com/django/django/pull/6035 pull request].
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:8>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by rowanv):
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:9>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by rowanv):
Submitted requested changes, updated
[https://github.com/django/django/pull/6035 pull request]
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:10>
Django
Reporter: timgraham | Owner: rowanv
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"a6ef025dfb2a1d1bd23893408eef6d066fb506d9" a6ef025]:
{{{
#!CommitTicketReference repository=""
revision="a6ef025dfb2a1d1bd23893408eef6d066fb506d9"
Fixed #26124 -- Added missing code formatting to docs headers.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:11>
Django
Reporter: timgraham | Owner: rowanv
Type: Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"a9fbf0735a213109ef4b02e02ff3e458b6a25929" a9fbf073]:
{{{
#!CommitTicketReference repository=""
revision="a9fbf0735a213109ef4b02e02ff3e458b6a25929"
[1.9.x] Fixed #26124 -- Added missing code formatting to docs headers.
Backport of a6ef025dfb2a1d1bd23893408eef6d066fb506d9 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/26124#comment:12>