Help text for several commands has inconsistent formatting
Bug #1628211 reported by
Matthew Helmke
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Canonical Juju |
Fix Released
|
Medium
|
Anastasia | ||
Bug Description
Formatting issues in the _Examples_ section makes the information harder to parse than is necessary for the following commands: run-action, set-meter-status, show-machine, sync-tools (which also includes deprecated flags), update-allocation.
Formatting issues in the _Details_ section involve text being formatted like examples are formatted in other help text for the following commands: run-action, show-status. This makes it more difficult to parse than necessary.
Also in run-action, the introduction to the list of supported types says "-type supports" instead of "supported types".
| tags: | added: usability |
| Changed in juju: | |
| status: | New → Triaged |
| importance: | Undecided → Medium |
| milestone: | none → 2.0.0 |
| Changed in juju: | |
| milestone: | 2.0.0 → 2.0.1 |
| Changed in juju: | |
| milestone: | 2.0.1 → none |
Revision history for this message
| Anastasia (anastasia-macmood) wrote | #1 |
| Changed in juju: | |
| status: | Triaged → In Progress |
| assignee: | nobody → Anastasia (anastasia-macmood) |
| Changed in juju: | |
| status: | In Progress → Fix Committed |
| milestone: | none → 2.6-beta1 |
| Changed in juju: | |
| status: | Fix Committed → Fix Released |
To post a comment you must log in.
PR against develop(2.6): https:/
It addresses Examples sections of the commands enumerated in this report (although I do not know where 'update-allocation' is coming from as it is not a Juju command).
The parts of the report for Details section and a typo has been addressed elsewhere.