-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[BEAM-14347] Update docs to prefer generic registration functions #17635
Conversation
Can one of the admins verify this patch? |
2 similar comments
Can one of the admins verify this patch? |
Can one of the admins verify this patch? |
Assigning reviewers. If you would like to opt out of this review, comment R: @jrmccluskey for label go. Available commands:
The PR bot will only process comments in the main thread (not review comments). |
R: @youngoli for final approval |
I'm actually going to override the bot and send this to Robert since he's been looking at the other registration stuff R: @lostluck |
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control |
Consider splitting the CHANGES.md messaging out to it's own PR. Since 2.40 doesn't release until July, the generics registration shouldn't yet be in the Programming Guide, when they can't be used for 6-8 weeks. Website changes are live within a day. |
Oh, forgot that the website doesn't get updated with releases. I opened #17643 and will close here for now |
@@ -185,6 +190,8 @@ func formatCoGBKResults(key string, emailIter, phoneIter func(*string) bool) str | |||
|
|||
func init() { | |||
beam.RegisterFunction(formatCoGBKResults) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This reveals we may want to also have a series of register.FuncDoFn
for func DoFns, which should be very similar but much much simpler than the struct ones.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops missed publishing these before you closed it.
WRT documentation changes, we likely do want to hold on making the beam package GoDoc mention these until we're unblocked from the import process.
But the other example code (everything in beam/examples) and integration test code can certainly make use of it before then. Doesn't need to be all at once, we can divide it amongst the team so folks can get used to it.
Now that we've proven out the effectiveness of the generic registration functions in #17613, we should update the docs to recommend that approach. This is the last piece of work for the generic registration to be done for now.
✨ RENDERED ✨
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
R: @username
).[BEAM-XXX] Fixes bug in ApproximateQuantiles
, where you replaceBEAM-XXX
with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.CHANGES.md
with 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.