Skip to content

Improve Javadoc for Coder class and clarify Context usage#38235

Merged
stankiewicz merged 4 commits intoapache:masterfrom
Subramanya-Veeregowda:fix-coder-javadoc-clean-v2
Apr 20, 2026
Merged

Improve Javadoc for Coder class and clarify Context usage#38235
stankiewicz merged 4 commits intoapache:masterfrom
Subramanya-Veeregowda:fix-coder-javadoc-clean-v2

Conversation

@Subramanya-Veeregowda
Copy link
Copy Markdown
Contributor

Improved Javadoc for the "Coder" class.

  • Clarified usage of "Context"
  • Explained "OUTER" vs "NESTED"
  • Cleaned up documentation without duplication

Closes #18184


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, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with 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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 focuses on improving the developer experience by refining the documentation within the Coder class. By clarifying the role of the Context parameter and removing redundant information, the changes ensure that developers have a better understanding of how to implement and use coders correctly within the framework.

Highlights

  • Documentation Improvement: Enhanced the Javadoc for the Coder class to provide clearer guidance on its usage.
  • Context Clarification: Added detailed explanations regarding the behavior of Context.OUTER versus Context.NESTED.

🧠 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.

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 👍 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.

Footnotes

  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.

@github-actions github-actions Bot added the java label Apr 17, 2026
@Subramanya-Veeregowda
Copy link
Copy Markdown
Contributor Author

@stankiewicz Thanks for the feedback on the previous PR. I’ve updated the Javadoc for the "Coder" class and created a new PR with a cleaner and minimal change.

@github-actions
Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.73%. Comparing base (c166bbe) to head (c3d3c1e).
⚠️ Report is 13 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master   #38235      +/-   ##
============================================
+ Coverage     54.61%   56.73%   +2.12%     
- Complexity     1689     3427    +1738     
============================================
  Files          1067     1182     +115     
  Lines        168147   188792   +20645     
  Branches       1226     3593    +2367     
============================================
+ Hits          91835   107115   +15280     
- Misses        74117    78288    +4171     
- Partials       2195     3389    +1194     
Flag Coverage Δ
java 71.96% <ø> (+4.61%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @ahmedabu98 for label java.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

@Subramanya-Veeregowda
Copy link
Copy Markdown
Contributor Author

@stankiewicz please go through this

Copy link
Copy Markdown
Contributor

@stankiewicz stankiewicz left a comment

Choose a reason for hiding this comment

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

thanks!

@stankiewicz stankiewicz merged commit 2ee8b6b into apache:master Apr 20, 2026
26 checks passed
@Subramanya-Veeregowda
Copy link
Copy Markdown
Contributor Author

thanks!

Thanks for the review and merge! I really appreciate your feedback and support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Coder encode/decode context documentation is lacking

2 participants