Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-23733

Broken link to java source code in Spark Scala api Scaladoc

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Duplicate
    • Affects Version/s: 1.6.3, 2.0.2, 2.1.2, 2.2.0
    • Fix Version/s: None
    • Environment:

      Description

      Java source code link in Spark api scaladoc is broken.

      The relative path expression "€{FILE_PATH}.scala" in https://github.com/apache/spark/blob/master/project/SparkBuild.scala has ".scala" hardcoded in the end. If I try to access the source link on https://spark.apache.org/docs/1.6.3/api/scala/index.html#org.apache.spark.api.java.function.Function2, it tries to take me to https://github.com/apache/spark/tree/v2.2.0/core/src/main/java/org/apache/spark/api/java/function/Function2.java.scala

      This is coming from /project/SparkBuild.scala :

      Line # 720

      // Use GitHub repository for Scaladoc source links
      unidocSourceBase := s"https://github.com/apache/spark/tree/v${version.value}",
      
      scalacOptions in (ScalaUnidoc, unidoc) ++= Seq(
      "-groups", // Group similar methods together based on the @group annotation.
      "-skip-packages", "org.apache.hadoop"
      ) ++ (
      // Add links to sources when generating Scaladoc for a non-snapshot release
      if (!isSnapshot.value) {
      Opts.doc.sourceUrl(unidocSourceBase.value + "€{FILE_PATH}.scala")
      } else {
      Seq()
      }
      )

       

       

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                yogeshtewari Yogesh Tewari
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: