[MINOR][DOCS] Updated the docstring of DataStreamWriter.foreach() method #51316
Conversation
This file contains hidden or 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
HyukjinKwon
approved these changes
Jun 30, 2025
HyukjinKwon
changed the title
|
Mind following https://github.com/apache/spark/pull/51316/checks?check_run_id=44993571999 and rebase to make sure the tests pass? |
github-actions
bot
added
SQL
ML
KUBERNETES
WEB UI
BUILD
YARN
DOCS
CORE
INFRA
DSTREAM
AVRO
PANDAS API ON SPARK
CONNECT
labels
|
Would you rebase latest master to keep the commit history clean? |
Fixed the documentation
@xinrong-meng , @HyukjinKwon - I have rebased to the latest master now. Apologies, I don't have much experience on Git and that's the reason I wasn't able to do this properly on the first time. |
|
LGTM! |
|
Merged to master. |
mzhang
pushed a commit
to mzhang/spark
that referenced
this pull request
Aug 21, 2025
Fixed the documentation ### What changes were proposed in this pull request? There isn't much clarity on the docstring of the DataStreamWriter.foreach() method that takes an object with process() method, as a input. As part of this PR, The docstring is fixed. ### Why are the changes needed? There isn't much clarity on the docstring of the DataStreamWriter.foreach() method that takes an object with process() method, as a input. ### Does this PR introduce _any_ user-facing change? Yes. This change modifies the docstring in the DataStreamWriter.foreach() method. ### How was this patch tested? Simple change on docstring. I haven't tested the changes. Need some support with the testing. ### Was this patch authored or co-authored using generative AI tooling? No Closes apache#51316 from nagaarjun-p/master. Authored-by: Mine4106 <[email protected]> Signed-off-by: Hyukjin Kwon <[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.
Fixed the documentation
What changes were proposed in this pull request?
There isn't much clarity on the docstring of the DataStreamWriter.foreach() method that takes an object with process() method, as a input. As part of this PR, The docstring is fixed.
Why are the changes needed?
There isn't much clarity on the docstring of the DataStreamWriter.foreach() method that takes an object with process() method, as a input.
Does this PR introduce any user-facing change?
Yes. This change modifies the docstring in the DataStreamWriter.foreach() method.
How was this patch tested?
Simple change on docstring. I haven't tested the changes. Need some support with the testing.
Was this patch authored or co-authored using generative AI tooling?
No