[ErrorProne] Fix MissingSummary Warnings Across Codebase#37759
Merged
kennknowles merged 1 commit intoapache:masterfrom Mar 4, 2026
Merged
[ErrorProne] Fix MissingSummary Warnings Across Codebase#37759kennknowles merged 1 commit intoapache:masterfrom
MissingSummary Warnings Across Codebase#37759kennknowles merged 1 commit intoapache:masterfrom
Conversation
github-actions
Bot
added
java
build
io
extensions
runners
spark
dataflow
aws
cassandra
gcp
jdbc
kafka
xml
core
fn-execution
samza
euphoria
sketching
healthcare
spanner
bigtable
labels
Contributor
Summary of ChangesHello, I'm Gemini Code Assist1! 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 significantly enhances the Javadoc quality across the Apache Beam codebase by resolving all instances of the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe 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
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 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 👍 and 👎 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. Footnotes
|
stankiewicz
changed the title
MissingSummary errorprone Warnings Across CodebaseMissingSummary Warnings Across Codebase
Contributor
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
Contributor
Author
|
assign set of reviewers this is javadoc change, tests are flaky. |
Contributor
|
Assigning reviewers: R: @kennknowles for label java. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
Contributor
|
LGTM for label Spanner |
kennknowles
approved these changes
Mar 4, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
his PR addresses all outstanding
MissingSummarywarnings across the codebase reported by Error Prone.The
MissingSummarycheck enforces that every Javadoc comment must have a proper summary fragment—typically the first sentence, which describes the objective of the method or class. Previously, several method Javadocs were either lacking this summary or relying entirely on@return/@param/@seetags without a preceding descriptive sentence.Changes in this PR include:
@return ...blocks into complete descriptive sentences (e.g.Returns ...).@see ...blocks into complete descriptive sentences (e.g.See {@link ...}).A wide array of modules have been updated, including Dataflow runners, various I/O connectors, extensions, and core SDK components.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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.CHANGES.mdwith noteworthy changes.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.