Opened 5 years ago

Closed 5 years ago

#30624 closed Cleanup/optimization (wontfix)

Use numbered list reStructuredText syntax throughout the docs.

Reported by: Jon Dufresne Owned by: Jon Dufresne
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: no UI/UX: no

Description

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

Change History (3)

comment:2 by Mariusz Felisiak, 5 years ago

Owner: changed from nobody to Jon Dufresne
Status: new → assigned
Triage Stage: Unreviewed → Accepted

comment:3 by Mariusz Felisiak, 5 years ago

Resolution: → wontfix
Status: assigned → closed

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.

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