[SPARK-40081][PYTHON][DOCS] Add document parameters for pyspark.sql.streaming.query#37587
Closed
dcoliversun wants to merge 4 commits intoapache:masterfrom
Closed
[SPARK-40081][PYTHON][DOCS] Add document parameters for pyspark.sql.streaming.query#37587dcoliversun wants to merge 4 commits intoapache:masterfrom
dcoliversun wants to merge 4 commits intoapache:masterfrom
Conversation
Contributor
Author
|
cc @HyukjinKwon @xinrong-meng |
|
Can one of the admins verify this patch? |
Member
|
cc @HeartSaVioR if you find some time to take a look |
HyukjinKwon
reviewed
Aug 22, 2022
HyukjinKwon
reviewed
Aug 22, 2022
HyukjinKwon
reviewed
Aug 22, 2022
| Returns | ||
| ------- | ||
| str or dict or list | ||
| An array of the most recent :class:`StreamingQueryProgress` updates for this query. |
Member
There was a problem hiding this comment.
Should probably mention that return a dictionary instead of StreamingQueryProgress instance.
Contributor
Author
There was a problem hiding this comment.
I choose to keep StreamingQueryProgress and add dict here. Because StreamingQueryProgress can help user to understand how it is in dictionary.
HyukjinKwon
reviewed
Aug 22, 2022
HyukjinKwon
reviewed
Aug 22, 2022
HyukjinKwon
reviewed
Aug 22, 2022
HyukjinKwon
reviewed
Aug 22, 2022
Member
|
Looks pretty good otherwise. |
HyukjinKwon
reviewed
Aug 23, 2022
Member
|
Merged to master. |
Member
|
Thanks for working on this @dcoliversun |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
As mentioned #37482 (comment), this PR proposes to add document parameters for
pyspark.sql.streaming.query.Why are the changes needed?
To make the documentation more readable.
Does this PR introduce any user-facing change?
Yes, it changes the documentation.
How was this patch tested?
Manually ran each doctest.