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/ml/wrapper.py | |
| 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:
.. looks like this once newline is added:
Author: noelsmith <mail@noelsmith.com>
Closes #8851 from noel-smith/docstring-missing-newline-fix.
Diffstat (limited to 'python/pyspark/ml/wrapper.py')
| -rw-r--r-- | python/pyspark/ml/wrapper.py | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/python/pyspark/ml/wrapper.py b/python/pyspark/ml/wrapper.py index 8218c7c5f8..4bcb4aaec8 100644 --- a/python/pyspark/ml/wrapper.py +++ b/python/pyspark/ml/wrapper.py @@ -119,6 +119,7 @@ class JavaEstimator(Estimator, JavaWrapper): def _fit_java(self, dataset): """ Fits a Java model to the input dataset. + :param dataset: input dataset, which is an instance of :py:class:`pyspark.sql.DataFrame` :param params: additional params (overwriting embedded values) @@ -173,6 +174,7 @@ class JavaModel(Model, JavaTransformer): extra params. This implementation first calls Params.copy and then make a copy of the companion Java model with extra params. So both the Python wrapper and the Java model get copied. + :param extra: Extra parameters to copy to the new instance :return: Copy of this instance """ |