You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bahir.apache.org by lr...@apache.org on 2016/06/10 15:23:45 UTC

[06/50] [abbrv] bahir git commit: [DOC] [PYSPARK] [MLLIB] Added newlines to docstrings to fix parameter formatting

[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 <ma...@noelsmith.com>

Closes #8851 from noel-smith/docstring-missing-newline-fix.


Project: http://git-wip-us.apache.org/repos/asf/bahir/repo
Commit: http://git-wip-us.apache.org/repos/asf/bahir/commit/2c8702fc
Tree: http://git-wip-us.apache.org/repos/asf/bahir/tree/2c8702fc
Diff: http://git-wip-us.apache.org/repos/asf/bahir/diff/2c8702fc

Branch: refs/heads/master
Commit: 2c8702fc1198bd0746a4f91a0e49a00fb2b3c9b0
Parents: e5d4bb7
Author: noelsmith <ma...@noelsmith.com>
Authored: Mon Sep 21 14:24:19 2015 -0700
Committer: Xiangrui Meng <me...@databricks.com>
Committed: Mon Sep 21 14:24:19 2015 -0700

----------------------------------------------------------------------
 streaming-mqtt/python/mqtt.py | 1 +
 1 file changed, 1 insertion(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/bahir/blob/2c8702fc/streaming-mqtt/python/mqtt.py
----------------------------------------------------------------------
diff --git a/streaming-mqtt/python/mqtt.py b/streaming-mqtt/python/mqtt.py
index f065989..fa83006 100644
--- a/streaming-mqtt/python/mqtt.py
+++ b/streaming-mqtt/python/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