[GitHub] [spark] zero323 commented on a change in pull request #30346: [SPARK-33253][PYTHON][DOCS] Migration to NumPy documentation style in Streaming (pyspark.streaming.*)

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

zero323 commented on a change in pull request #30346:
URL: https://github.com/apache/spark/pull/30346#discussion_r521983849



##########
File path: python/pyspark/streaming/context.py
##########
@@ -46,9 +46,13 @@ def __init__(self, sparkContext, batchDuration=None, jssc=None):
         """
         Create a new StreamingContext.
 
-        :param sparkContext: :class:`SparkContext` object.
-        :param batchDuration: the time interval (in seconds) at which streaming
-                              data will be divided into batches
+        Parameters
+        ----------
+        sparkContext : :class:`SparkContext`
+            SparkContext object.
+        batchDuration : int, optional
+            the time interval (in seconds) at which streaming
+            data will be divided into batches

Review comment:
       Shall we move this to class doc instead, so it is visible in the rendered docs?




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

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