diff options
author | noelsmith <mail@noelsmith.com> | 2015-09-21 14:24:19 -0700 |
---|---|---|
committer | Xiangrui Meng <meng@databricks.com> | 2015-09-21 14:24:19 -0700 |
commit | 7c4f852bfc39537840f56cd8121457a0dc1ad7c1 (patch) | |
tree | 12c3ae141dc204124c86e3a644a8c97434db5755 /python/pyspark/streaming | |
parent | 362539f8d97f6bb67f0d0983f7dea36b77cc9d18 (diff) | |
download | spark-7c4f852bfc39537840f56cd8121457a0dc1ad7c1.tar.gz spark-7c4f852bfc39537840f56cd8121457a0dc1ad7c1.tar.bz2 spark-7c4f852bfc39537840f56cd8121457a0dc1ad7c1.zip |
[DOC] [PYSPARK] [MLLIB] Added newlines to docstrings to fix parameter formatting
Added newlines before `:param ...:` and `:return:` markup. Without these, parameter lists aren't formatted correctly in the API docs. I.e:
![screen shot 2015-09-21 at 21 49 26](https://cloud.githubusercontent.com/assets/11915197/10004686/de3c41d4-60aa-11e5-9c50-a46dcb51243f.png)
.. looks like this once newline is added:
![screen shot 2015-09-21 at 21 50 14](https://cloud.githubusercontent.com/assets/11915197/10004706/f86bfb08-60aa-11e5-8524-ae4436713502.png)
Author: noelsmith <mail@noelsmith.com>
Closes #8851 from noel-smith/docstring-missing-newline-fix.
Diffstat (limited to 'python/pyspark/streaming')
-rw-r--r-- | python/pyspark/streaming/context.py | 2 | ||||
-rw-r--r-- | python/pyspark/streaming/mqtt.py | 1 |
2 files changed, 3 insertions, 0 deletions
diff --git a/python/pyspark/streaming/context.py b/python/pyspark/streaming/context.py index 4069d7a149..a8c9ffc235 100644 --- a/python/pyspark/streaming/context.py +++ b/python/pyspark/streaming/context.py @@ -240,6 +240,7 @@ class StreamingContext(object): def awaitTermination(self, timeout=None): """ Wait for the execution to stop. + @param timeout: time to wait in seconds """ if timeout is None: @@ -252,6 +253,7 @@ class StreamingContext(object): Wait for the execution to stop. Return `true` if it's stopped; or throw the reported error during the execution; or `false` if the waiting time elapsed before returning from the method. + @param timeout: time to wait in seconds """ self._jssc.awaitTerminationOrTimeout(int(timeout * 1000)) diff --git a/python/pyspark/streaming/mqtt.py b/python/pyspark/streaming/mqtt.py index f06598971c..fa83006c36 100644 --- a/python/pyspark/streaming/mqtt.py +++ b/python/pyspark/streaming/mqtt.py @@ -31,6 +31,7 @@ class MQTTUtils(object): storageLevel=StorageLevel.MEMORY_AND_DISK_SER_2): """ Create an input stream that pulls messages from a Mqtt Broker. + :param ssc: StreamingContext object :param brokerUrl: Url of remote mqtt publisher :param topic: topic name to subscribe to |