[GitHub] [opennlp] mawiesne opened a new pull request, #474: OPENNLP-1429 Add the Internal annotation to interfaces and classes documented accordingly

[GitBox <gi...@apache.org>]

mawiesne opened a new pull request, #474:
URL: https://github.com/apache/opennlp/pull/474

   Change
   -
   
   - adds `Internal` annotation to code which has existing hints/notes on internal use
   - improves some JavaDoc by linking to existing classes or interfaces
   - fixes inconsistent JavaDoc in `SentenceModelLoader`
   - adds 'final' modifier where useful and applicable
   - adds 'Override' annotation where useful and applicable
   - fixes some typos
   
   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 main)?
   
   - [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] mawiesne merged pull request #474: OPENNLP-1429 Add the Internal annotation to interfaces and classes documented accordingly

[GitBox <gi...@apache.org>]

mawiesne merged PR #474:
URL: https://github.com/apache/opennlp/pull/474


-- 
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 #474: OPENNLP-1429 Add the Internal annotation to interfaces and classes documented accordingly

[GitBox <gi...@apache.org>]

rzo1 commented on code in PR #474:
URL: https://github.com/apache/opennlp/pull/474#discussion_r1059495443


##########
opennlp-tools/src/main/java/opennlp/tools/cmdline/entitylinker/EntityLinkerTool.java:
##########
@@ -50,7 +50,7 @@ public void run(String[] args) {
       System.out.println(getHelp());
     }
     else {
-      // TODO: Ask Mark if we can remove the type, the user knows upfront if he tries
+      // TODO: Ask Mark if we can remove the type, the user knows upfront if s/he tries

Review Comment:
   Who is Mark? :)



-- 
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