aboutsummaryrefslogtreecommitdiff
path: root/python/pyspark/mllib
diff options
context:
space:
mode:
authornoelsmith <mail@noelsmith.com>2015-09-21 14:24:19 -0700
committerXiangrui Meng <meng@databricks.com>2015-09-21 14:24:19 -0700
commit7c4f852bfc39537840f56cd8121457a0dc1ad7c1 (patch)
tree12c3ae141dc204124c86e3a644a8c97434db5755 /python/pyspark/mllib
parent362539f8d97f6bb67f0d0983f7dea36b77cc9d18 (diff)
downloadspark-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/mllib')
-rw-r--r--python/pyspark/mllib/evaluation.py2
-rw-r--r--python/pyspark/mllib/linalg/__init__.py1
2 files changed, 2 insertions, 1 deletions
diff --git a/python/pyspark/mllib/evaluation.py b/python/pyspark/mllib/evaluation.py
index 4398ca86f2..a90e5c50e5 100644
--- a/python/pyspark/mllib/evaluation.py
+++ b/python/pyspark/mllib/evaluation.py
@@ -147,7 +147,7 @@ class MulticlassMetrics(JavaModelWrapper):
"""
Evaluator for multiclass classification.
- :param predictionAndLabels an RDD of (prediction, label) pairs.
+ :param predictionAndLabels: an RDD of (prediction, label) pairs.
>>> predictionAndLabels = sc.parallelize([(0.0, 0.0), (0.0, 1.0), (0.0, 0.0),
... (1.0, 0.0), (1.0, 1.0), (1.0, 1.0), (1.0, 1.0), (2.0, 2.0), (2.0, 0.0)])
diff --git a/python/pyspark/mllib/linalg/__init__.py b/python/pyspark/mllib/linalg/__init__.py
index f929e3e96f..ea42127f16 100644
--- a/python/pyspark/mllib/linalg/__init__.py
+++ b/python/pyspark/mllib/linalg/__init__.py
@@ -240,6 +240,7 @@ class Vector(object):
def toArray(self):
"""
Convert the vector into an numpy.ndarray
+
:return: numpy.ndarray
"""
raise NotImplementedError