[
https://issues.apache.org/jira/browse/OPENNLP-1385?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17624057#comment-17624057
]
ASF GitHub Bot commented on OPENNLP-1385:
-----------------------------------------
atarora opened a new pull request, #428:
URL: https://github.com/apache/opennlp/pull/428
Thank you for contributing to Apache OpenNLP.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [x] Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [x] Has your PR been rebased against the latest commit within the target
branch (typically master)?
- [ ] Is your initial contribution a single, squashed commit?
### For code changes:
- [x] Have you ensured that the full suite of tests is executed via mvn
clean install at the root opennlp folder?
- [x] Have you written or updated unit tests to verify your changes?
- [x] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the LICENSE file, including the main
LICENSE file in opennlp folder?
- [ ] If applicable, have you updated the NOTICE file, including the main
NOTICE file found in opennlp folder?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in which
it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions for
build issues and submit an update to your PR as soon as possible.
> Fix discrepancy in tokenizer documentation
> ------------------------------------------
>
> Key: OPENNLP-1385
> URL: https://issues.apache.org/jira/browse/OPENNLP-1385
> Project: OpenNLP
> Issue Type: Task
> Components: Documentation, Tokenizer
> Affects Versions: 1.9.4, 2.0.0
> Reporter: Jeff Zemerick
> Assignee: Atita Arora
> Priority: Major
>
> In the tokenizer documentation in the user guide, the usage of the tool shows
> a cutoff option:
> -cutoff num
> minimal number of times a feature must be seen, ignored if
> -params is used.
> However, this option is not present in the usage when running the CLI:
> {quote}Arguments description:
> -factory factoryName
> A sub-class of TokenizerFactory where to get implementation
> and resources.
> -abbDict path
> abbreviation dictionary in XML format.
> -alphaNumOpt isAlphaNumOpt
> Optimization flag to skip alpha numeric tokens for further
> tokenization
> -params paramsFile
> training parameters file.
> -lang language
> language which is being processed.
> -model modelFile
> output model file.
> -data sampleData
> data to be used, usually a file name.
> -encoding charsetName
> encoding for reading and writing text, if absent the system
> default is used.
> {quote}
> The CLI does not recognize cutoff as an option so it is likely the
> documentation is incorrect but a review of the code should probably be done
> first to be sure.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
