Enhance Javadoc documentation for WordCount Tokenizer class #26751
+10
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@Diogo-Sardagna please associate this change the title to include a Jira or include hotfix as per the process |
davidradl
reviewed
Jul 10, 2025
| * | ||
| * <p>The tokenizer performs the following operations: | ||
| * <ul> | ||
| * <li>Converts input text to lowercase for case-insensitive word counting</li> |
There was a problem hiding this comment.
I think the code is pretty self explanatory - I suggest that we do not need this extra comment.
github-actions
bot
added
community-reviewed
github-actions
bot
added
community-reviewed
github-actions
bot
added
community-reviewed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the Javadoc for the WordCount.Tokenizer class to provide a clear and structured explanation of its behavior. The new documentation outlines the purpose of the class, how the input is normalized, how tokens are generated, and under what conditions they are emitted. It also includes structured HTML formatting for improved readability. This enhancement facilitates understanding for new contributors and readers of the codebase, aligning with the documentation quality expected in Apache Flink examples.