Fix Javadoc Unicode rendering issue with RIGHT SINGLE QUOTATION MARK
- Add docencoding UTF-8 option to Javadoc configuration in BeamModulePlugin
- Replace U+2019 (RIGHT SINGLE QUOTATION MARK) with ASCII apostrophe in source files
- Fixes rendering issue where Unicode apostrophes show as â in generated Javadoc
Fixes rendering of text like 'doesn't' which was showing as 'doesnât' in HTML output.
Please add a meaningful description for your change here
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead. - [ ] Update
CHANGES.mdwith noteworthy changes. - [ ] If this contribution is large, please file an Apache Individual Contributor License Agreement.
See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.
Summary of Changes
Hello @Arunodoy18, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a Javadoc rendering issue where Unicode apostrophes were displayed incorrectly. It resolves this by standardizing Javadoc encoding configurations to UTF-8 across the build system and by replacing specific Unicode quotation marks with their ASCII equivalents in relevant source files. These changes ensure that generated documentation displays special characters correctly, improving readability and consistency.
Highlights
- Javadoc Encoding Configuration: Explicitly set "docEncoding" and "charSet" to "UTF-8" in the "BeamModulePlugin" and the "aggregateJavadoc" Gradle task to ensure consistent UTF-8 output for generated Javadoc documentation.
- Unicode Character Replacement: Replaced instances of the Unicode RIGHT SINGLE QUOTATION MARK (U+2019) with the standard ASCII apostrophe (U+0027) in source files to prevent incorrect rendering in generated Javadoc.
- Byte Order Mark (BOM) Addition: Added a Byte Order Mark (BOM) to the beginning of "KafkaIO.java" and "KafkaReadSchemaTransformConfiguration.java" to help ensure proper UTF-8 interpretation of these files.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
I have done the following changes, Anyone to just revise it once would be helpful. Thank you.
Thanks, I understand this fixes #25427 ?
Not sure how KafkaIO.java get touched (and caused spotless check failure). Consider reverting unrelated changes?
Fixes #25427
Summary
This PR fixes the issue described in #25427 where
The root cause was <1–2 lines explaining the specific code problem>.
This change ensures that
Changes in This PR
- Updated <file_name> to
. - Added/updated
. - Ensured compatibility with existing IO connectors.
- Reverted accidental/unrelated changes (e.g.,
KafkaIO.java).
No other files were modified.
Validation
./gradlew clean buildpassed locally./gradlew spotlessApplywas run to ensure format compliance- Relevant unit tests were executed:
<list test classes if needed>
- Verified behavior by <brief description, e.g., running example pipeline>.
Notes for Reviewers
- This PR contains only the minimal changes required to fix #25427.
- No unrelated formatting or refactoring changes are included.
Please let me know if additional test coverage or documentation updates are needed.
During investigation, I confirmed that modifying KafkaIO.java was unintentional
and caused Spotless failures. Those changes have been reverted.
This PR now focuses solely on the fix for #25427.
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers