Skip to content

OPENNLP-1401 Enhance JavaDoc in opennlp.tools.chunker package#444

Merged
kinow merged 1 commit intoapache:masterfrom
mawiesne:OPENNLP-1401_Enhance_JavaDoc_in_opennlp.tools.chunker_package
Dec 4, 2022
Merged

OPENNLP-1401 Enhance JavaDoc in opennlp.tools.chunker package#444
kinow merged 1 commit intoapache:masterfrom
mawiesne:OPENNLP-1401_Enhance_JavaDoc_in_opennlp.tools.chunker_package

Conversation

@mawiesne
Copy link
Copy Markdown
Contributor

@mawiesne mawiesne commented Dec 4, 2022

Change

  • adds missing JavaDoc
  • improves existing documentation for clarity
  • removes superfluous text
  • fixes typos
  • adds 'final' modifier where useful and applicable
  • adds 'Override' annotation where useful and applicable
  • removes deprecated and unused constructor in ChunkerME

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 master)?

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

- adds missing JavaDoc
- improves existing documentation for clarity
- removes superfluous text
- fixes typos
- adds 'final' modifier where useful and applicable
- adds 'Override' annotation where useful and applicable
- removes deprecated and unused constructor in ChunkerME
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.

Thank you for improving the javadocs, making variable names more consistent and easier to understand, marking some fields as final, and also fixing typos! 🙏

@kinow kinow merged commit df91f27 into apache:master Dec 4, 2022
@mawiesne mawiesne deleted the OPENNLP-1401_Enhance_JavaDoc_in_opennlp.tools.chunker_package branch December 4, 2022 09:50
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