[SPARK-40027][PYTHON][SS][DOCS] Add self-contained examples for pyspark.sql.streaming.readwriter #37461
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
|
cc @viirya and @HeartSaVioR mind taking a look please when you find some time? |
HyukjinKwon
force-pushed
the
SPARK-40027
branch
from
c916bd4
to
e4daee1
Compare
viirya
reviewed
Aug 10, 2022
Comment on lines
+811
to
+813
| >>> df = spark.readStream.format("rate").load() | ||
| >>> df.writeStream.format("text") | ||
| <pyspark.sql.streaming.readwriter.DataStreamWriter object ...> |
There was a problem hiding this comment.
Is this redundant? Looks not related to the example below.
There was a problem hiding this comment.
the purpose is to show the type of DataStreamWriter?
There was a problem hiding this comment.
Yeah. It's a separate example. In the documentation, it shows like:
HeartSaVioR
reviewed
Aug 10, 2022
Both, yes :-). |
zhengruifeng
approved these changes
Aug 11, 2022
|
Merged to master. |
|
I am touching these examples a lot. So all posthoc reviews are very appreciated! |
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.
What changes were proposed in this pull request?
This PR proposes to improve the examples in
pyspark.sql.streaming.readwriterby making each example self-contained with a brief explanation and a bit more realistic example.Why are the changes needed?
To make the documentation more readable and able to copy and paste directly in PySpark shell.
Does this PR introduce any user-facing change?
Yes, it changes the documentation
How was this patch tested?
Manually ran each doctest.