You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Jijo Sunny (Jira)" <ji...@apache.org> on 2020/06/26 06:49:00 UTC

[jira] [Created] (SPARK-32102) Broken link to java source code in Spark Scala api doc

Jijo Sunny created SPARK-32102:
----------------------------------

             Summary: Broken link to java source code in Spark Scala api doc
                 Key: SPARK-32102
                 URL: https://issues.apache.org/jira/browse/SPARK-32102
             Project: Spark
          Issue Type: Bug
          Components: Build, Documentation, Project Infra
    Affects Versions: 1.6.3, 2.0.2, 2.1.2, 2.2.0
         Environment: {code:java}
~/spark/docs$ cat /etc/*release*
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=16.04
DISTRIB_CODENAME=xenial
DISTRIB_DESCRIPTION="Ubuntu 16.04.4 LTS"
NAME="Ubuntu"
VERSION="16.04.4 LTS (Xenial Xerus)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 16.04.4 LTS"
VERSION_ID="16.04"
HOME_URL="http://www.ubuntu.com/"
SUPPORT_URL="http://help.ubuntu.com/"
BUG_REPORT_URL="http://bugs.launchpad.net/ubuntu/"
VERSION_CODENAME=xenial
UBUNTU_CODENAME=xenial
{code}
Using spark packaged sbt.

Other versions:
{code:java}
~/spark/docs$ ruby -v 
ruby 2.3.1p112 (2016-04-26) [x86_64-linux-gnu] 
~/spark/docs$ gem -v 
2.5.2.1 
~/spark/docs$ jekyll -v 
jekyll 3.7.3  
~/spark/docs$ java -version 
java version "1.8.0_112" Java(TM) SE Runtime Environment (build 1.8.0_112-b15) Java HotSpot(TM) 64-Bit Server VM (build 25.112-b15, mixed mode)
{code}
            Reporter: Jijo Sunny


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
{code:java}
// 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()
}
){code}
 

 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org