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

Broken link to java source code in Spark Scala api doc

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Open
    • Priority: Trivial
    • Resolution: Unresolved
    • Affects Version/s: 2.4.4, 2.4.5
    • Fix Version/s: None
    • Environment:

      Description

      Java source code link in Spark api scaladoc is broken. This issue still persists for all Java files referred from scala doc in versions 2.4.4 & 2.4.5

      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/2.4.4/api/scala/index.html#org.apache.spark.sql.sources.v2.DataSourceOptions, it tries to take me to https://github.com/apache/spark/tree/v2.4.4/sql/core/src/main/java/org/apache/spark/sql/sources/v2/DataSourceOptions.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:
                jijosg Jijo Sunny
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: