[ 
https://issues.apache.org/jira/browse/CLI-171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12639407#action_12639407
 ] 

hamaryns edited comment on CLI-171 at 10/14/08 6:15 AM:
--------------------------------------------------------------

Wait a moment, I see now that Ant is particular in that it does not follow the 
standard Linux conventions of giving long options the prefix '\-\-'.  So either 
you have to revert that and only fix the user typo, or you use the 
DefaultOptionBuilder constructor which sets the long argument prefix to '\-' 
and include a comment about that.  I think the latter would be preferable, 
because it illustrates what these things are for more clearly.

Also, I'd suggest to use parseAndHelp() and set the help formatter before doing 
so.  But I suppose I should make another bug for that.

Shall I have a go at it?

      was (Author: hamaryns):
    Wait a moment, I see now that Ant is particular in that it does not follow 
the standard Linux conventions of giving long options the prefix --.  So either 
you have to revert that and only fix the user typo, or you use the 
DefaultOptionBuilder constructor which sets the long argument prefix to '-' and 
include a comment about that.  I think the latter would be preferable, because 
it illustrates what these things are for more clearly.

Also, I'd suggest to use parseAndHelp() and set the help formatter before doing 
so.  But I suppose I should make another bug for that.

Shall I have a go at it?
  
> Typo in ant documentation, more logical example code
> ----------------------------------------------------
>
>                 Key: CLI-171
>                 URL: https://issues.apache.org/jira/browse/CLI-171
>             Project: Commons CLI
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 2.1
>            Reporter: Hendrik Maryns
>            Priority: Trivial
>             Fix For: 2.1
>
>         Attachments: ant-doc.patch
>
>   Original Estimate: 0.08h
>  Remaining Estimate: 0.08h
>
> ant.xml contains a typo (used → user).
> Furthermore, it uses withShortName for the full-word arguments.  I would use 
> withLongName for that.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to