Skip to content

Fix coder encode decode javadoc#37963

Open
Subramanya-Veeregowda wants to merge 5 commits intoapache:masterfrom
Subramanya-Veeregowda:fix-coder-encode-decode-javadoc
Open

Fix coder encode decode javadoc#37963
Subramanya-Veeregowda wants to merge 5 commits intoapache:masterfrom
Subramanya-Veeregowda:fix-coder-encode-decode-javadoc

Conversation

@Subramanya-Veeregowda
Copy link
Contributor

Improved Javadoc for Context in Coder class.

  • Added proper summary line to satisfy Checkstyle
  • Clarified OUTER vs NESTED usage with examples
  • Fixed formatting and @deprecated usage

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
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 primarily focuses on enhancing documentation across two key areas: improving the Javadoc for the Coder class in Java to clarify the usage and purpose of Context in encoding and decoding operations, and expanding the Python programming guide with new examples for advanced field selection patterns. The changes aim to provide clearer guidance and better understanding for developers using these functionalities.

Highlights

  • Improved Javadoc for Coder.Context: The Javadoc for the Coder.Context class has been significantly enhanced, including a proper summary line, clearer explanations of OUTER vs NESTED contexts, and practical usage examples. Redundant Javadoc for individual fields within Context was removed as the class-level documentation now covers their meaning.
  • Enhanced Coder encode and decode Javadoc: The Javadoc for both the encode and decode methods in the Coder class has been updated. This includes better descriptions of how values are handled, the importance of boundary information for multiple elements, and how Context influences encoding/decoding. The @deprecated messages for context-aware methods were also refined.
  • Added Python SDK documentation examples: New examples have been added to the programming guide for the Python SDK, demonstrating how to use wildcard selection for nested fields, select nested fields within arrays, and select specific keys from map fields.

🧠 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
Copy link
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

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.

1 participant