Added documentation for return vs yield usage in DoFn.process()#34912
Added documentation for return vs yield usage in DoFn.process()#34912damccorm merged 8 commits intoapache:masterfrom
Conversation
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
damccorm
left a comment
There was a problem hiding this comment.
Thanks for picking this up!
Co-authored-by: Danny McCormick <dannymccormick@google.com>
|
@damccorm kindly review the PR and approve it |
damccorm
left a comment
There was a problem hiding this comment.
Please also check the precommits which are automatically run. In this case, the whitespace precommit is failing because you have trailing whitespace in some of your lines
|
|
||
| <span class="language-python"> | ||
|
|
||
| > **Returning a single element (e.g., `return element`) is incorrect** |
There was a problem hiding this comment.
Could you please flip the order of the descriptions and the examples? Otherwise, I worry people will just read the example and follow it without seeing the description saying it is wrong
There was a problem hiding this comment.
It does not look like you addressed this - please move the "Returning a single element" section to the back of the order
|
Assigning reviewers: R: @damccorm for label website. 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). |
|
waiting on author |
Thanks @damccorm! I believe I’ve addressed all the comments. Please let me know if anything else is required |
|
waiting on author |
damccorm
left a comment
There was a problem hiding this comment.
Thanks - this lgtm other than 2 changes which I'll apply before merging
Issue Link : #34906
Please add a meaningful description for your change here
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.