[jira] Created: (CLI-197) boolean option in documentation is woorking oposite way documented

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

[jira] Created: (CLI-197) boolean option in documentation is woorking oposite way documented

JIRA jira@apache.org
boolean option in documentation is woorking oposite way documented
------------------------------------------------------------------

                 Key: CLI-197
                 URL: https://issues.apache.org/jira/browse/CLI-197
             Project: Commons CLI
          Issue Type: Bug
          Components: Documentation
            Reporter: Anders Larsson
            Priority: Minor


In documentation it says as follows:

CommandLine parse(Options options,
                  String[] arguments,
                  boolean stopAtNonOption)
                  throws ParseException

        stopAtNonOption - specifies whether to continue parsing the arguments if a non option is encountered.


The parser stops an throws Exception if "stopAtNonOption" is set to false (when I guess it should be other way round), if I set boolean "true", the parser ignores unknown arguments and continues without throwing Exception.

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

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CLI-197) boolean option in documentation is woorking oposite way documented

JIRA jira@apache.org

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

Emmanuel Bourg commented on CLI-197:
------------------------------------

This isn't an error in the documentation but it might be more explicit: if stopAtNonOption is true an unrecognized token stops the parsing and the remaining tokens are added as extra arguments. If stopAtNonOption is false the parsing breaks with an exception.

"Stop" doesn't refer to the action of throwing an exception, it refers to the change of the parser behavior.

> boolean option in documentation is woorking oposite way documented
> ------------------------------------------------------------------
>
>                 Key: CLI-197
>                 URL: https://issues.apache.org/jira/browse/CLI-197
>             Project: Commons CLI
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Anders Larsson
>            Priority: Minor
>   Original Estimate: 0.17h
>  Remaining Estimate: 0.17h
>
> In documentation it says as follows:
> CommandLine parse(Options options,
>                   String[] arguments,
>                   boolean stopAtNonOption)
>                   throws ParseException
>         stopAtNonOption - specifies whether to continue parsing the arguments if a non option is encountered.
> The parser stops an throws Exception if "stopAtNonOption" is set to false (when I guess it should be other way round), if I set boolean "true", the parser ignores unknown arguments and continues without throwing Exception.

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

Reply | Threaded
Open this post in threaded view
|

[jira] Resolved: (CLI-197) boolean option in documentation is woorking oposite way documented

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

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

Emmanuel Bourg resolved CLI-197.
--------------------------------

    Fix Version/s: 1.3
       Resolution: Not A Problem

I updated the javadoc to better explain the stopAtNonOption parameter. I hope this will clear the confusion.

> boolean option in documentation is woorking oposite way documented
> ------------------------------------------------------------------
>
>                 Key: CLI-197
>                 URL: https://issues.apache.org/jira/browse/CLI-197
>             Project: Commons CLI
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Anders Larsson
>            Priority: Minor
>             Fix For: 1.3
>
>   Original Estimate: 0.17h
>  Remaining Estimate: 0.17h
>
> In documentation it says as follows:
> CommandLine parse(Options options,
>                   String[] arguments,
>                   boolean stopAtNonOption)
>                   throws ParseException
>         stopAtNonOption - specifies whether to continue parsing the arguments if a non option is encountered.
> The parser stops an throws Exception if "stopAtNonOption" is set to false (when I guess it should be other way round), if I set boolean "true", the parser ignores unknown arguments and continues without throwing Exception.

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

Reply | Threaded
Open this post in threaded view
|

[jira] Reopened: (CLI-197) boolean option in documentation is woorking oposite way documented

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

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

Emmanuel Bourg reopened CLI-197:
--------------------------------


> boolean option in documentation is woorking oposite way documented
> ------------------------------------------------------------------
>
>                 Key: CLI-197
>                 URL: https://issues.apache.org/jira/browse/CLI-197
>             Project: Commons CLI
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Anders Larsson
>            Priority: Minor
>             Fix For: 1.3
>
>   Original Estimate: 0.17h
>  Remaining Estimate: 0.17h
>
> In documentation it says as follows:
> CommandLine parse(Options options,
>                   String[] arguments,
>                   boolean stopAtNonOption)
>                   throws ParseException
>         stopAtNonOption - specifies whether to continue parsing the arguments if a non option is encountered.
> The parser stops an throws Exception if "stopAtNonOption" is set to false (when I guess it should be other way round), if I set boolean "true", the parser ignores unknown arguments and continues without throwing Exception.

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

Reply | Threaded
Open this post in threaded view
|

[jira] Resolved: (CLI-197) boolean option in documentation is woorking oposite way documented

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

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

Emmanuel Bourg resolved CLI-197.
--------------------------------

    Resolution: Fixed

> boolean option in documentation is woorking oposite way documented
> ------------------------------------------------------------------
>
>                 Key: CLI-197
>                 URL: https://issues.apache.org/jira/browse/CLI-197
>             Project: Commons CLI
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Anders Larsson
>            Priority: Minor
>             Fix For: 1.3
>
>   Original Estimate: 0.17h
>  Remaining Estimate: 0.17h
>
> In documentation it says as follows:
> CommandLine parse(Options options,
>                   String[] arguments,
>                   boolean stopAtNonOption)
>                   throws ParseException
>         stopAtNonOption - specifies whether to continue parsing the arguments if a non option is encountered.
> The parser stops an throws Exception if "stopAtNonOption" is set to false (when I guess it should be other way round), if I set boolean "true", the parser ignores unknown arguments and continues without throwing Exception.

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