[YAML] Better docs for Filter and MapToFields. #33274
Merged
Conversation
This file contains 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
|
R: @Polber Noticed this when reviewing the other PR. |
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
Polber
suggested changes
Dec 4, 2024
Comment on lines
686
to
693
| append: (Optional) Whether to append the created fields to the set of | ||
| fields already present, outputting a union of both the new fields and | ||
| the original fields for each record. Defaults to False. | ||
| drop: (Optional) If `append` is true, enumerates a subset of fields from the | ||
| original record that should not be kept | ||
| language: (Optional) The language used to define (and execute) the | ||
| expressions and/or callables in `fields`. Defaults to generic. | ||
| error_handling: (Optional) Whether and where to output records that throw errors when |
There was a problem hiding this comment.
The (Optional) tags should already be added by generate_yaml_docs since all these args have default values (which would cause it to get printed twice)
|
Resolved the comments. @Polber PTAL. |
Co-authored-by: Jeff Kinard <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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.