#26124: Add missing code formatting in docs headers
--------------------------------------+------------------------------------
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
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 <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/067.6683c119afd85108d22c816dd1792557%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
