Fix coder encode decode javadoc#37963
Conversation
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 primarily focuses on enhancing documentation across two key areas: improving the Javadoc for 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. 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. Footnotes
|
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
|
Re-running CI. The failure appears in macOS tests and seems unrelated to the Javadoc changes. I'll wait for the rerun results, but please let me know if I should investigate further. |
Subramanya-Veeregowda
force-pushed
the
fix-coder-encode-decode-javadoc
branch
from
8bd79ed to
e47a3db
Compare
|
Why checks are stuck should I draft and recommit again? Any further improvements needed? Open to improve if any specific improvements needed |
Subramanya-Veeregowda
force-pushed
the
fix-coder-encode-decode-javadoc
branch
from
a721623 to
7609051
Compare
|
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). |
|
@Subramanya-Veeregowda pr is empty, should we close it or are you planning to continue working on this? |
|
a local issue where i added javadoc may be the file is not added, Sorry for the empty PR, i will update it ASAP! |
github-actions
Bot
added
Next Action: Reviewers
build
and removed
Next Action: Author
build
labels
There was a problem hiding this comment.
@stankiewicz Can you tell me why my checks are failing and what is the issue, I am new into this world so i can't figure it out on my own if there are any specific needs for improvements i would like to work on it
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #37963 +/- ##
============================================
- Coverage 57.34% 56.84% -0.50%
+ Complexity 5115 3426 -1689
============================================
Files 1392 1178 -214
Lines 197103 187943 -9160
Branches 4817 3593 -1224
============================================
- Hits 113020 106841 -6179
+ Misses 80247 77710 -2537
+ Partials 3836 3392 -444
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
start with PreCommit Spotless - Before submitting PR, it's worth setting up environment - following guides can help you:
There are also agent skills added that will help you finding some gradle tasks, like spotless. works really well with gemini cli and antigravity. |
|
Reminder, please take a look at this pr: @kennknowles |
|
waiting on Author |
github-actions
Bot
added
build
Next Action: Reviewers
and removed
slow-review
build
Next Action: Author
labels
Subramanya-Veeregowda
force-pushed
the
fix-coder-encode-decode-javadoc
branch
from
6941e98 to
d6bd34a
Compare
Subramanya-Veeregowda
force-pushed
the
fix-coder-encode-decode-javadoc
branch
from
d6bd34a to
c6899fb
Compare
There was a problem hiding this comment.
shouldn't be part of commit
There was a problem hiding this comment.
there a lot of duplicate javadoc, please simplify it a bit.
| @@ -37,7 +37,9 @@ | |||
| import org.checkerframework.checker.nullness.qual.Nullable; | |||
|
|
|||
| /** | |||
| * A {@link Coder Coder<T>} defines how to encode and decode values of type {@code T} into | |||
| * Use {@link CoderProperties} to verify the correctness of a {@link Coder} implementation. | |||
There was a problem hiding this comment.
does have to be first sentence?
| @@ -52,6 +54,18 @@ | |||
| * <p>All methods of a {@link Coder} are required to be thread safe. | |||
| * | |||
| * @param <T> the type of values being encoded and decoded | |||
| * | |||
| * <p>When implementing a {@link Coder}, it is important to understand the role | |||
There was a problem hiding this comment.
Does it have to be part of this javadoc?
| * include sufficient length information (such as prefixes) to allow correct | ||
| * decoding of subsequent values. | ||
| * | ||
| * <p>Use {@link CoderProperties} in tests to verify correctness, determinism, |
| @@ -60,6 +74,14 @@ public abstract class Coder<T> implements Serializable { | |||
| * @deprecated To implement a coder, do not use any {@link Context}. Just implement only those | |||
| * abstract methods which do not accept a {@link Context} and leave the default | |||
| * implementations for methods accepting a {@link Context}. | |||
| * <p>There are two common contexts: | |||
| * <p>The encoding behavior depends on the {@link Context}: | ||
| * | ||
| * <ul> | ||
| * <li>In {@link Context#OUTER}, the value occupies the remainder of the stream, so no |
There was a problem hiding this comment.
those descriptions are inconsistent.
| * @throws IOException if writing to the {@code OutputStream} fails for some reason | ||
| * @throws CoderException if the value could not be encoded for some reason | ||
| * | ||
| * <p>Implementers must ensure that encoding in {@link Context#NESTED} |
There was a problem hiding this comment.
this is duplicate but written slightly differently.
Subramanya-Veeregowda
force-pushed
the
fix-coder-encode-decode-javadoc
branch
from
c6899fb to
dedbb88
Compare
Subramanya-Veeregowda
force-pushed
the
fix-coder-encode-decode-javadoc
branch
from
c801cc3 to
f300e59
Compare
2 participants
Improved Javadoc for Context in Coder class.
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.