[jira] [Updated] (AURORA-737) Improve clientv2 usage helplines.

["Chris Lambert (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/AURORA-737?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Chris Lambert updated AURORA-737:
---------------------------------
    Sprint: Aurora Q3 Sprint 2, Aurora Q3 Sprint 3  (was: Aurora Q3 Sprint 2)

> Improve clientv2 usage helplines.
> ---------------------------------
>
>                 Key: AURORA-737
>                 URL: https://issues.apache.org/jira/browse/AURORA-737
>             Project: Aurora
>          Issue Type: Task
>            Reporter: Mark Chu-Carroll
>            Assignee: Mark Chu-Carroll
>
> This is created in response to user complaints.
> The "usage" line in aurora clientv2 help is automatically generated from command options. When an option doesn't explicitly declare a string to be used as the displayname of an option, the system defaults to using the type of the parameter. For some parameters, this is perfectly fine. For example,
> "--watch-secs=int" is clear about what it expects.
> In other places, though, it's very unclear. For example, for creating a job, the user sees:
> {noformat}
>   create [--bind=pystachio-binding] [--read-json] [--wait-until=('PENDING', 'RUNNING', 'FINISHED')] [--open-browser] CLUSTER/ROLE/ENV/NAME str
> {noformat}
> What is the "str" supposed to mean? 
> In all of  the places where the typename is displayed, and its meaning is unclear, the code should explicitly specify a display name/format for the parameter.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)