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

[Python] Add doc comment for WriteToText.skip_if_empty #30409

Merged
merged 2 commits into from
Feb 27, 2024

Conversation

riteshghorse
Copy link
Contributor

@riteshghorse riteshghorse commented Feb 23, 2024

Fixes #27926

Add clarifying doc comment for skip_if_empty in WriteToText


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
  • 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
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

Copy link
Contributor

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

R: @damccorm for label python.
R: @johnjcasey for label io.

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

@damccorm
Copy link
Contributor

I don't think we should actually change the behavior here. I'd vote we just document the parameter a little better. I left a couple comments in the issue this is responding to.

@riteshghorse
Copy link
Contributor Author

That makes sense. I think it will confuse users if the file exists even though PCollection was empty.

@riteshghorse riteshghorse changed the title Skip deleting empty file in case of no shards and skip_if_empty [Python] Add doc comment for WriteToText.skip_if_empty Feb 23, 2024
@riteshghorse riteshghorse merged commit 2a84a20 into apache:master Feb 27, 2024
72 checks passed
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.

[Bug]: beam.io.WriteToText deletes existing file even if skip_if_empty=True
2 participants