cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mike Sierra (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-3794) clarify required vs. optional syntax
Date Thu, 13 Jun 2013 16:33:20 GMT

    [ https://issues.apache.org/jira/browse/CB-3794?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13682393#comment-13682393
] 

Mike Sierra commented on CB-3794:
---------------------------------

Rusty on this. Sampled a couple of pages (http://tinyurl.com/l5jo27z, http://bit.ly/1a815La),
based on which I suggest this:

create <PATH> [ID] [NAME]
platform(s) {add|remove} <NAME>
platform(s) ls
plugin(s) {add|remove} <PATH>
plugin(s) ls
prepare [PLATFORM...]
compile [PLATFORM...]
build [PLATFORM...]
emulate [PLATFORM...]
run [PLATFORM...]
ripple <PLATFORM> [PORT]

...where UPPERCASE clarifies variables; <THIS> is mandatory; {THIS|THAT} is mandatory;
[THIS] or [THIS|THAT] is optional; [THESE...] could be more than one.  IMO, better to break
"ls" onto a different line than represent how only {add|remove} require an additional arg.
                
> clarify required vs. optional syntax
> ------------------------------------
>
>                 Key: CB-3794
>                 URL: https://issues.apache.org/jira/browse/CB-3794
>             Project: Apache Cordova
>          Issue Type: Bug
>          Components: CLI
>            Reporter: Mike Sierra
>            Assignee: Filip Maj
>            Priority: Minor
>
> Run "cordova" with no argument. Syntax list doesn't always distinguish <mandatory>
path vs [optional] id/name arguments:
> create [path] [id] [name]
> Perhaps represent mandatory "platform" syntax like this?
> platform(s) <add|remove|ls [name]>

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message