[GitHub] [spark] dcoliversun commented on a diff in pull request #37587: [SPARK-40081][PYTHON][DOCS] Add document parameters for pyspark.sql.streaming.query

[GitBox <gi...@apache.org>]

dcoliversun commented on code in PR #37587:
URL: https://github.com/apache/spark/pull/37587#discussion_r950987447


##########
python/pyspark/sql/streaming/query.py:
##########
@@ -189,6 +226,11 @@ def recentProgress(self) -> List[Dict[str, Any]]:
         The number of progress updates retained for each stream is configured by Spark session
         configuration `spark.sql.streaming.numRecentProgressUpdates`.
 
+        Returns
+        -------
+        str or dict or list
+            An array of the most recent :class:`StreamingQueryProgress` updates for this query.

Review Comment:
   I choose to keep `StreamingQueryProgress` and add `dict` here. Because `StreamingQueryProgress` can help user to understand how it is in `dictionary`.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org