maas-cli help is hard to read
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
MAAS |
Fix Released
|
Critical
|
Gavin Panella |
Bug Description
ubuntu@
usage: /usr/lib/
[-h] uuid [data [data ...]]
:param ip: Static IP of the interface. :type ip: basestring (IP Address)
:param interface: Name of the interface. :type interface: basestring :param
management: The service(s) MAAS should manage on this interface. :type
management: Vocabulary `NODEGROUPINTER
Subnet mask, e.g. 255.0.0.0. :type subnet_mask: basestring (IP Address) :param
broadcast_ip: Broadcast address for this subnet. :type broadcast_ip:
basestring (IP Address) :param router_ip: Address of default gateway. :type
router_ip: basestring (IP Address) :param ip_range_low: Lowest IP address to
assign to clients. :type ip_range_low: basestring (IP Address) :param
ip_range_high: Highest IP address to assign to clients. :type ip_range_high:
basestring (IP Address)
positional arguments:
uuid
data
optional arguments:
-h, --help show this help message and exit
The help for the data argument is hard to read since it doesn't have any line breaks.
Related branches
- Julian Edwards (community): Approve
-
Diff: 137 lines (+29/-49)3 files modifiedsrc/maascli/__init__.py (+7/-1)
src/maascli/tests/test_utils.py (+12/-33)
src/maascli/utils.py (+10/-15)
tags: | added: api cli |
Changed in maas: | |
status: | New → Triaged |
importance: | Undecided → Critical |
Changed in maas: | |
status: | Triaged → In Progress |
assignee: | nobody → Gavin Panella (allenap) |
Changed in maas: | |
status: | In Progress → Fix Committed |
Changed in maas: | |
status: | Fix Committed → Fix Released |
There's some fairly naive docstring reformatting code in maascli that
could probably be taught to split paragraphs on leading colons, as a
quick fix for now. A better fix is to parse the docstrings with
docutils and include a structured document in the API description, so
that maas-cli can render it more faithfully.