You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@opennlp.apache.org by GitBox <gi...@apache.org> on 2022/12/09 09:12:37 UTC
[GitHub] [opennlp] mawiesne opened a new pull request, #449: OPENNLP-1406 Enhance JavaDoc in opennlp.tools.parser package
mawiesne opened a new pull request, #449:
URL: https://github.com/apache/opennlp/pull/449
Change
-
- adds missing JavaDoc
- improves existing documentation for clarity
- removes superfluous text
- removes orphaned (commented) code fragments in `..parser.treeinsert.ParserEventStream`
- fixes a missing variable assignment in `ParserCrossValidator` (a hidden bug)
- adds 'final' modifier where useful and applicable
- adds 'Override' annotation where useful and applicable
- fixes several typos
- corrects some inconsistencies in the `opennlp.tools.chunker` and `opennlp.tools.langdetect` package
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?
- [ ] 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [opennlp] jzonthemtn merged pull request #449: OPENNLP-1406 Enhance JavaDoc in opennlp.tools.parser package
Posted by GitBox <gi...@apache.org>.
jzonthemtn merged PR #449:
URL: https://github.com/apache/opennlp/pull/449
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [opennlp] rzo1 commented on a diff in pull request #449: OPENNLP-1406 Enhance JavaDoc in opennlp.tools.parser package
Posted by GitBox <gi...@apache.org>.
rzo1 commented on code in PR #449:
URL: https://github.com/apache/opennlp/pull/449#discussion_r1044334326
##########
opennlp-tools/src/main/java/opennlp/tools/parser/ParserEventTypeEnum.java:
##########
@@ -19,13 +19,14 @@
package opennlp.tools.parser;
/**
- * Enumerated type of event types for the parser.
+ * Enumeration of event types for a {@link Parser}.
*/
public enum ParserEventTypeEnum {
BUILD,
CHECK,
+ // TODO Add reason why those enum values are deprecated
Review Comment:
+1
##########
opennlp-tools/src/main/java/opennlp/tools/parser/ParserModel.java:
##########
@@ -41,16 +41,15 @@
import opennlp.tools.util.model.POSModelSerializer;
/**
- * This is an abstract base class for {@link ParserModel} implementations.
+ * This is the default {@link ParserModel} implementation.
*/
-// TODO: Model should validate the artifact map
Review Comment:
Is this still a valid todo?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [opennlp] mawiesne commented on a diff in pull request #449: OPENNLP-1406 Enhance JavaDoc in opennlp.tools.parser package
Posted by GitBox <gi...@apache.org>.
mawiesne commented on code in PR #449:
URL: https://github.com/apache/opennlp/pull/449#discussion_r1044397338
##########
opennlp-tools/src/main/java/opennlp/tools/parser/ParserModel.java:
##########
@@ -41,16 +41,15 @@
import opennlp.tools.util.model.POSModelSerializer;
/**
- * This is an abstract base class for {@link ParserModel} implementations.
+ * This is the default {@link ParserModel} implementation.
*/
-// TODO: Model should validate the artifact map
Review Comment:
No, as this is done in `ParserModel`. That's why I removed the orphaned TODO here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org