[Django] #30624: Use numbered list reStructuredText syntax throughout the docs.
Django
------------------------------------------------+------------------------
Reporter: Jon Dufresne | 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: 0
UI/UX: 0 |
------------------------------------------------+------------------------
reStructuredText has syntax to automatically number ordered lists. To use
it, begin list items with `#. ` rather than an explicit number. The
numbered list syntax simplifies future maintenance:
- As items are added or removed, the rendered items are automatically
renumbered.
- If a long list happens to reach double digits, all items remain indented
the same.
Sphinx documentation on the feature: http://www.sphinx-
doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-
blocks
--
Ticket URL: <https://code.djangoproject.com/ticket/30624>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Jon Dufresne | Owner: nobody
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Jon Dufresne):
* has_patch: 0 => 1
Comment:
https://github.com/django/django/pull/11546
--
Ticket URL: <https://code.djangoproject.com/ticket/30624#comment:1>
Django
Reporter: Jon Dufresne | Owner: Jon
Type: | Dufresne
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* status: new => assigned
* owner: nobody => Jon Dufresne
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/30624#comment:2>
Django
Reporter: Jon Dufresne | Owner: Jon
Type: | Dufresne
Component: Documentation | Version: master
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* status: assigned => closed
* resolution: => wontfix
Comment:
Thanks for this ticket and patch, but after all I agree with Carlton, I
don't think that we need to change this in an existing documentation. We
can prefer `#.` for future changes.
--
Ticket URL: <https://code.djangoproject.com/ticket/30624#comment:3>