incorrect ReST markup in CLI documentation

Bug #1743040 reported by Brian Rosmaita
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Glance
Fix Released
Low
Unassigned

Bug Description

This applies to the files in doc/source/cli

The options are marked up as a definition list, with the options in bold, for example:

  **-o, --option**
    This is an option.

  **-a, --another**
    This is another option.

This is a problem because when the document is rendered into HTML by Sphinx, '--' is converted into a single character, 0x2013 (en dash) instead of remaining as two consecutive hyphens. This is confusing to readers.

The options should instead be marked up as an option list:

  -o, --option This is an option.
  -a, --another This is another option.

There must be at least 2 spaces between the option and the description. The options will be rendered in monospace font and the two hyphens are preserved.

See http://docutils.sourceforge.net/docs/user/rst/quickref.html#option-lists

tags: added: documentation
Changed in glance:
status: New → Triaged
importance: Undecided → Low
Changed in glance:
assignee: nobody → Sana Khan (sana.khan)
Revision history for this message
Brian Rosmaita (brian-rosmaita) wrote :

Looks like this was fixed a different way by Change-Id: Ie29e71f0394a432c255804b0d549aba56d1d5a1d

https://review.openstack.org/#/c/549180/

Changed in glance:
assignee: Sana Khan (sana.khan) → nobody
status: Triaged → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.