Skip to content
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

Closed

Conversation

damccorm
Copy link
Contributor

@damccorm damccorm commented May 12, 2022

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:

  • Choose reviewer(s) and mention them in a comment (R: @username).
  • Format the pull request title like [BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replace BEAM-XXX with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
  • 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

See CI.md for more information about GitHub Actions CI.

@asf-ci
Copy link

asf-ci commented May 12, 2022

Can one of the admins verify this patch?

2 similar comments
@asf-ci
Copy link

asf-ci commented May 12, 2022

Can one of the admins verify this patch?

@asf-ci
Copy link

asf-ci commented May 12, 2022

Can one of the admins verify this patch?

@damccorm damccorm marked this pull request as ready for review May 12, 2022 16:00
@github-actions
Copy link
Contributor

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

R: @jrmccluskey for label go.

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

@github-actions
Copy link
Contributor

R: @youngoli for final approval

@damccorm
Copy link
Contributor Author

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

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control

@lostluck
Copy link
Contributor

lostluck commented May 12, 2022

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.

@damccorm
Copy link
Contributor Author

Oh, forgot that the website doesn't get updated with releases. I opened #17643 and will close here for now

@damccorm damccorm closed this May 12, 2022
@@ -185,6 +190,8 @@ func formatCoGBKResults(key string, emailIter, phoneIter func(*string) bool) str

func init() {
beam.RegisterFunction(formatCoGBKResults)
Copy link
Contributor

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.

Copy link
Contributor

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.

@damccorm damccorm deleted the users/damccorm/registration-docs branch June 1, 2022 17:56
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.

4 participants