[
https://issues.apache.org/jira/browse/OPENNLP-1419?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17649477#comment-17649477
]
ASF GitHub Bot commented on OPENNLP-1419:
-----------------------------------------
mawiesne opened a new pull request, #465:
URL: https://github.com/apache/opennlp/pull/465
Change
-
- renames some unit test classes to match the class names under test
- introduces common base test class `AbstractMorfologikTest` to reduce
dependencies among test classes
- extracts (test) resource loading to separate methods in
`AbstractMorfologikTest`
- adds further assertions in
`MorfologikPOSTaggerFactoryTest#testPOSTaggerWithCustomFactory()`
- adds missing JavaDoc to impl classes
- improves existing documentation for clarity
- adds 'Override' annotation where useful and applicable
- fixes several typos, e.g. in `XMLDictionaryToTableParams`
Tasks
-
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)?
- [x] 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?
- [ ] 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.
> Enhance Tests and JavaDoc in opennlp.morfologik package
> -------------------------------------------------------
>
> Key: OPENNLP-1419
> URL: https://issues.apache.org/jira/browse/OPENNLP-1419
> Project: OpenNLP
> Issue Type: Improvement
> Components: Morfologik Addon
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Assignee: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The (JUnit) tests in _opennlp.morfologik_ package show an anti-pattern of
> test classes relying on each other, that is: code is mixed around and feels
> near to spaghetti. Moreover, the naming of some of the existing test classes
> is not consistent with the classes under test. This should both be fixed and
> improved.
> The JavaDoc the _opennlp.morfologik_ package shows several inconsistencies
> and missing descriptions. Moreover, several typos are present that need
> sanitizing, especially in class names.
> Both aspects need a cure and the package some additions to provide more
> clarity for readers of the API and devs with respect to understanding the
> test setup correctly.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
