Skip to content

Enhance Javadoc documentation for WordCount Tokenizer class #26751

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

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

Conversation

Diogo-Sardagna
Copy link

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.

@flinkbot
Copy link
Collaborator

flinkbot commented Jul 3, 2025

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@davidradl
Copy link
Contributor

@Diogo-Sardagna please associate this change the title to include a Jira or include hotfix as per the process

*
* <p>The tokenizer performs the following operations:
* <ul>
* <li>Converts input text to lowercase for case-insensitive word counting</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the code is pretty self explanatory - I suggest that we do not need this extra comment.

@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Jul 10, 2025
@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Jul 18, 2025
@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Jul 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-reviewed PR has been reviewed by the community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants