Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OPENNLP-287: Extend POS Tagger documentation with more information about the tag dictionary #754

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

NishantShri4
Copy link

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.

@NishantShri4
Copy link
Author

NishantShri4 commented Mar 16, 2025

Post changes, the rendered documentation (for Tag Dictionary section) looks like this -
PosTagger_Tag_Dictionary_Documentation_After_Changes_PR_754.pdf

@NishantShri4
Copy link
Author

Hi @kottmann - Would you like to review this one and share comments?

@jzonthemtn
Copy link
Contributor

Thanks @NishantShri4! Definitely a gap in the documentation. This looks good to me. I admit I did not run the example code though.

Copy link
Contributor

@mawiesne mawiesne left a comment

Choose a reason for hiding this comment

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

Thx a lot @NishantShri4 for your first contribution to Apache OpenNLP! Highly welcome and a valuable addition to the dev manual! I've projected that issue for the upcoming maintenance release 2.5.4

Copy link
Contributor

@atarora atarora left a comment

Choose a reason for hiding this comment

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

Looks good ! Thank you !

@mawiesne mawiesne changed the title OPENNLP-287 Extend POS Tagger documentation with more information about the tag dictionary OPENNLP-287: Extend POS Tagger documentation with more information about the tag dictionary Mar 19, 2025
@mawiesne mawiesne added the documentation Pull requests that update documentation label Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests that update documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants