Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-2830 MLlib v1.1 documentation
  3. SPARK-3249

Fix links in ScalaDoc that cause warning messages in `sbt/sbt unidoc`

    Details

    • Type: Sub-task
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.1.0
    • Fix Version/s: 2.2.0
    • Component/s: Documentation, MLlib
    • Labels:
      None

      Description

      If there are multiple overloaded versions of a method, we should make the links more specific. Otherwise, `sbt/sbt unidoc` generates warning messages like the following:

      [warn] mllib/src/main/scala/org/apache/spark/mllib/tree/DecisionTree.scala:305: The link target "org.apache.spark.mllib.tree.DecisionTree$#trainClassifier" is ambiguous. Several members fit the target:
      [warn] (input: org.apache.spark.api.java.JavaRDD[org.apache.spark.mllib.regression.LabeledPoint],numClassesForClassification: Int,categoricalFeaturesInfo: java.util.Map[Integer,Integer],impurity: String,maxDepth: Int,maxBins: Int): org.apache.spark.mllib.tree.model.DecisionTreeModel in object DecisionTree [chosen]
      [warn] (input: org.apache.spark.rdd.RDD[org.apache.spark.mllib.regression.LabeledPoint],numClassesForClassification: Int,categoricalFeaturesInfo: Map[Int,Int],impurity: String,maxDepth: Int,maxBins: Int): org.apache.spark.mllib.tree.model.DecisionTreeModel in object DecisionTree
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                hyukjin.kwon Hyukjin Kwon
                Reporter:
                mengxr Xiangrui Meng
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: