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/param/__init__.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/param/__init__.py')
| -rw-r--r-- | python/pyspark/ml/param/__init__.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/python/pyspark/ml/param/__init__.py b/python/pyspark/ml/param/__init__.py index eeeac49b21..2e0c63cb47 100644 --- a/python/pyspark/ml/param/__init__.py +++ b/python/pyspark/ml/param/__init__.py @@ -164,6 +164,7 @@ class Params(Identifiable): a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values < user-supplied values < extra. + :param extra: extra param values :return: merged param map """ @@ -182,6 +183,7 @@ class Params(Identifiable): embedded and extra parameters over and returns the copy. Subclasses should override this method if the default approach is not sufficient. + :param extra: Extra parameters to copy to the new instance :return: Copy of this instance """ @@ -201,6 +203,7 @@ class Params(Identifiable): def _resolveParam(self, param): """ Resolves a param and validates the ownership. + :param param: param name or the param instance, which must belong to this Params instance :return: resolved param instance @@ -243,6 +246,7 @@ class Params(Identifiable): """ Copies param values from this instance to another instance for params shared by them. + :param to: the target instance :param extra: extra params to be copied :return: the target instance with param values copied |