scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.
https://scala-lang.org
232 stars 21 forks source link

Scaladoc links disambiguation issues #8723

Open scabug opened 10 years ago

scabug commented 10 years ago
Link.scala:22: warning: The link target "scala.concurrent.ExecutionContext$.fromExecutor(e:java\.util\.concurrent\.Executor*" is ambiguous. Several members fit the target:
(e: java.util.concurrent.Executor,reporter: Throwable => Unit): scala.concurrent.ExecutionContextExecutor in object ExecutionContext [chosen]
(e: java.util.concurrent.Executor): scala.concurrent.ExecutionContextExecutor in object ExecutionContext

Instead, the signatures should be:

[[fromExecutor(e:java\.util\.concurrent\.Executor,reporter:Throwable=>Unit): scala\.concurrent\.ExecutionContextExecutor]] in object ExecutionContext [chosen]
[[fromExecutor(e:java\.util\.concurrent\.Executor):scala\.concurrent\.ExecutionContextExecutor]] in object ExecutionContext

Steps necessary:

Another problem: in the crash course, escaping is incorrect:

Notes:
 - you can use any number of matching square brackets to avoid interference with the signature
 - you can use \\. to escape dots in prefixes (don't forget to use * at the end to match the signature!)
 - you can use \\# to escape hashes, otherwise they will be considered as delimiters, like dots.

We need:

scabug commented 10 years ago

Imported From: https://issues.scala-lang.org/browse/SI-8723?orig=1 Reporter: @VladUreche

eatkins commented 5 years ago

Bump. It is a nightmare trying to disambiguate signatures for scaladoc and the current message is both not helpful for certain failures and wrong (see comment above about \\. vs \.).