Skip to content

OPENNLP-1423 Enhance JavaDoc in opennlp.tools.ml package#469

Merged
mawiesne merged 1 commit intoapache:mainfrom
mawiesne:OPENNLP-1423_Enhance_JavaDoc_in_opennlp.tools.ml_package
Dec 27, 2022
Merged

OPENNLP-1423 Enhance JavaDoc in opennlp.tools.ml package#469
mawiesne merged 1 commit intoapache:mainfrom
mawiesne:OPENNLP-1423_Enhance_JavaDoc_in_opennlp.tools.ml_package

Conversation

@mawiesne
Copy link
Copy Markdown
Contributor

Change

  • adds missing JavaDoc for opennlp.tools.ml
  • improves existing documentation for clarity
  • removes superfluous text
  • adds 'final' modifier where useful and applicable
  • adds 'Override' annotation where useful and applicable
  • adds package-info.java files for several sub-packages
  • simplifies several constructors, removing duplicate code
  • fixes several 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:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

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

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • 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?
  • 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:

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

@mawiesne mawiesne requested review from kinow and rzo1 December 23, 2022 12:29
@mawiesne
Copy link
Copy Markdown
Contributor Author

That's my Merry Xmas PR for 2022 🎄🌟

Copy link
Copy Markdown
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whew, 90 files. Started reviewing it until I realized the number of files.

Fast-scrolled through some random files, and found nothing that looked strange or wrong.

And given your record of great PR's, I'd say +1 LGTM.

Thanks a lot, merry x-mas @mawiesne & y'all!

- adds missing JavaDoc for `opennlp.tools.ml`
- improves existing documentation for clarity
- removes superfluous text
- adds 'final' modifier where useful and applicable
- adds 'Override' annotation where useful and applicable
- adds `package-info.java` files for several sub-packages
- simplifies several constructors, removing duplicate code
- fixes several typos
- marks AbstractTrainer.init(..) method to as deprecated
- addresses PR review comments
@mawiesne mawiesne merged commit abcc0a2 into apache:main Dec 27, 2022
@mawiesne mawiesne deleted the OPENNLP-1423_Enhance_JavaDoc_in_opennlp.tools.ml_package branch December 27, 2022 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants