GitHub user HyukjinKwon opened a pull request:
https://github.com/apache/spark/pull/16604
[SPARK-3249][DOC] Fix links in ScalaDoc that cause warning messages in
`sbt/sbt unidoc`
## What changes were proposed in this pull request?
This PR proposes to fix ambiguous link warnings by simply making them as
code blocks for both javadoc and scaladoc.
```
[warn] .../spark/core/src/main/scala/org/apache/spark/Accumulator.scala:20:
The link target "SparkContext#accumulator" is ambiguous. Several members fit
the target:
[warn]
.../spark/mllib/src/main/scala/org/apache/spark/mllib/optimization/GradientDescent.scala:281:
The link target "runMiniBatchSGD" is ambiguous. Several members fit the target:
[warn]
.../spark/mllib/src/main/scala/org/apache/spark/mllib/fpm/AssociationRules.scala:83:
The link target "run" is ambiguous. Several members fit the target:
...
```
This PR also fixes javadoc8 break as below:
```
[error]
.../spark/sql/core/target/java/org/apache/spark/sql/LowPrioritySQLImplicits.java:7:
error: reference not found
[error] * newProductEncoder - to disambiguate for {@link List}s which are
both {@link Seq} and {@link Product}
[error] ^
[error]
.../spark/sql/core/target/java/org/apache/spark/sql/LowPrioritySQLImplicits.java:7:
error: reference not found
[error] * newProductEncoder - to disambiguate for {@link List}s which are
both {@link Seq} and {@link Product}
[error]
^
[error]
.../spark/sql/core/target/java/org/apache/spark/sql/LowPrioritySQLImplicits.java:7:
error: reference not found
[error] * newProductEncoder - to disambiguate for {@link List}s which are
both {@link Seq} and {@link Product}
[error]
^
[info] 3 errors
```
## How was this patch tested?
Manually via `sbt unidoc > output.txt` and the checked it via `cat
output.txt | grep ambiguous`.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/HyukjinKwon/spark SPARK-3249
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/16604.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #16604
----
commit 151d40b1eeaea065fe037da5c29057dbc1b3aab7
Author: hyukjinkwon <[email protected]>
Date: 2017-01-16T13:20:47Z
Fix links for javadoc and scaladoc
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
