maas-cli help is hard to read

Bug #1059984 reported by Diogo Matsubara
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
Fix Released
Critical
Gavin Panella

Bug Description

ubuntu@lenovo-RD230-01:~$ maas-cli api maas node-group-interfaces new -h
usage: /usr/lib/python2.7/dist-packages/maascli/__main__.py api maas node-group-interfaces new
       [-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 `NODEGROUPINTERFACE_MANAGEMENT` :param subnet_mask:
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.

Tags: api cli

Related branches

tags: added: api cli
Changed in maas:
status: New → Triaged
importance: Undecided → Critical
Revision history for this message
Gavin Panella (allenap) wrote : Re: [Bug 1059984] Re: maas-cli help is hard to read

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.

Gavin Panella (allenap)
Changed in maas:
status: Triaged → In Progress
assignee: nobody → Gavin Panella (allenap)
Gavin Panella (allenap)
Changed in maas:
status: In Progress → Fix Committed
Changed in maas:
status: Fix Committed → 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.