CLI tools that uses Pameters interface should print detailed usage information
------------------------------------------------------------------------------

                 Key: OPENNLP-224
                 URL: https://issues.apache.org/jira/browse/OPENNLP-224
             Project: OpenNLP
          Issue Type: Improvement
          Components: Command Line Interface
    Affects Versions: tools-1.5.2-incubating
            Reporter: William Colen
            Assignee: William Colen
            Priority: Minor
             Fix For: tools-1.5.2-incubating


We should add arguments description to the usage of the CL tools. Today we have 
the description annotation but it is not used.

Today the command outputs:
---
$ bin/opennlp SentenceDetectorEvaluator
Usage: opennlp SentenceDetectorEvaluator -data testData -model model 
[-printErrors isPrintErrors] [-encoding charsetName]
---

But should output:
---
$ bin/opennlp SentenceDetectorEvaluator
Usage: opennlp SentenceDetectorEvaluator -data testData -model model 
[-printErrors isPrintErrors] [-encoding charsetName]

Description:
        -data testData
                the data to be used during evaluation
        -model model
                the model file to be evaluated
        -printErrors isPrintErrors
                if true will print false negatives and positives
        -encoding charsetName
                specifies the encoding which should be used for reading and 
writing text. If not specified the system default will be used.
---

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to