Docs: document accepted encoder/decoder signatures on coder.RegisterCoder - #40050
Draft
nitinware wants to merge 1 commit into
Draft
Docs: document accepted encoder/decoder signatures on coder.RegisterCoder#40050nitinware wants to merge 1 commit into
nitinware wants to merge 1 commit into
Conversation
Adds explicit encoder/decoder function signature documentation to coder.RegisterCoder, matching the signatures already documented on the top-level beam.RegisterCoder wrapper. NewCustomCoder now points at the same signature spec. Addresses apache#21930
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
1 participant
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.
Addresses #21930
Adds explicit encoder/decoder function signature documentation to
coder.RegisterCoder, matching the four signatures already documented onthe top-level
beam.RegisterCoderwrapper inforward.go. Also adds ashort note on
NewCustomCoderpointing at the same signature spec, sinceit accepts the same functions.
Docs-only change — no behavior modification.
go vetandgo buildon
pkg/beam/core/graph/coder/...both clean.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.