diff options
author | Xiangrui Meng <meng@databricks.com> | 2016-06-22 15:50:21 -0700 |
---|---|---|
committer | Xiangrui Meng <meng@databricks.com> | 2016-06-22 15:50:21 -0700 |
commit | 00cc5cca4522297b63b1522a2b8643b1a098e2b3 (patch) | |
tree | 061a6cc796fe1e17d71d2d33ac107904440a6a15 | |
parent | 20d411bc5d05dd099f6d5234a24e10a519a39bdf (diff) | |
download | spark-00cc5cca4522297b63b1522a2b8643b1a098e2b3.tar.gz spark-00cc5cca4522297b63b1522a2b8643b1a098e2b3.tar.bz2 spark-00cc5cca4522297b63b1522a2b8643b1a098e2b3.zip |
[SPARK-16153][MLLIB] switch to multi-line doc to avoid a genjavadoc bug
## What changes were proposed in this pull request?
We recently deprecated setLabelCol in ChiSqSelectorModel (#13823):
~~~scala
/** group setParam */
Since("1.6.0")
deprecated("labelCol is not used by ChiSqSelectorModel.", "2.0.0")
def setLabelCol(value: String): this.type = set(labelCol, value)
~~~
This unfortunately hit a genjavadoc bug and broken doc generation. This is the generated Java code:
~~~java
/** group setParam */
public org.apache.spark.ml.feature.ChiSqSelectorModel setOutputCol (java.lang.String value) { throw new RuntimeException(); }
*
* deprecated labelCol is not used by ChiSqSelectorModel. Since 2.0.0.
*/
public org.apache.spark.ml.feature.ChiSqSelectorModel setLabelCol (java.lang.String value) { throw new RuntimeException(); }
~~~
Switching to multiline is a workaround.
Author: Xiangrui Meng <meng@databricks.com>
Closes #13855 from mengxr/SPARK-16153.
-rw-r--r-- | mllib/src/main/scala/org/apache/spark/ml/feature/ChiSqSelector.scala | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/mllib/src/main/scala/org/apache/spark/ml/feature/ChiSqSelector.scala b/mllib/src/main/scala/org/apache/spark/ml/feature/ChiSqSelector.scala index 38b4db99bc..712634dffb 100644 --- a/mllib/src/main/scala/org/apache/spark/ml/feature/ChiSqSelector.scala +++ b/mllib/src/main/scala/org/apache/spark/ml/feature/ChiSqSelector.scala @@ -140,7 +140,9 @@ final class ChiSqSelectorModel private[ml] ( @Since("1.6.0") def setOutputCol(value: String): this.type = set(outputCol, value) - /** @group setParam */ + /** + * @group setParam + */ @Since("1.6.0") @deprecated("labelCol is not used by ChiSqSelectorModel.", "2.0.0") def setLabelCol(value: String): this.type = set(labelCol, value) |