Usage is inconsistent and does not follow usage standards
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Glance Client |
Fix Released
|
Low
|
Gabe Westmaas |
Bug Description
Option arguments for glanceclient commands use differing usage syntax:
For example, glance help image-list uses curly braces for option choices
...
Optional arguments:
...
--sort-key {name,status,
--sort-dir {asc,desc}
...
while glance help image-update shows square brackets for option choices:
...
Optional arguments:
...
--is-public [True|False]
--is-protected [True|False]
...
There is no clear standard for how to handle the listing of choices but square brackets are always used to show optional parameters which these are not.
The IEEE standard does not seem to be clear on what to do:
http://
This link says to use curly braces for option choices:
http://
Changed in python-glanceclient: | |
importance: | Undecided → Low |
Changed in python-glanceclient: | |
assignee: | nobody → Gabe Westmaas (westmaas) |
Changed in python-glanceclient: | |
status: | Fix Committed → Fix Released |
In the legacy shell, they use brackets. docs.python. org/3.4/ library/ argparse. html#choices
The thing is, those with {} are the product of argparse's internal rendering.
http://
whereas the rest are hardcode.
I personally would go with the dicts for one reason: there are too many brackets already and the cmds are already too long, too much to digest for my human eyes...