incorrect ReST markup in CLI documentation
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://
tags: | added: documentation |
Changed in glance: | |
status: | New → Triaged |
importance: | Undecided → Low |
Changed in glance: | |
assignee: | nobody → Sana Khan (sana.khan) |
Looks like this was fixed a different way by Change-Id: Ie29e71f0394a43 2c255804b0d549a ba56d1d5a1d
https:/ /review. openstack. org/#/c/ 549180/