Skip to content

Commit

Permalink
Merge pull request #10458 from j-mie6/patch/remove-crash-course-add-link
Browse files Browse the repository at this point in the history
Removed Crash Course for Ambiguous links
  • Loading branch information
som-snytt committed Jul 13, 2023
2 parents b913236 + 2c10fbb commit dd33bd3
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions src/scaladoc/scala/tools/nsc/doc/base/MemberLookupBase.scala
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,9 @@ trait MemberLookupBase {
private def explanation: String =
if (showExplanation) {
showExplanation = false
"""
|Quick crash course on using Scaladoc links
|==========================================
|Disambiguating terms and types: Suffix terms with '$' and types with '!' in case both names are in use:
| - [[scala.collection.immutable.List!.apply class List's apply method]] and
| - [[scala.collection.immutable.List$.apply object List's apply method]]
|Disambiguating overloaded members: If a term is overloaded, you can indicate the first part of its signature followed by *:
| - [[[scala.collection.immutable.List$.fill[A](Int)(=> A):List[A]* Fill with a single parameter]]]
| - [[[scala.collection.immutable.List$.fill[A](Int, Int)(=> A):List[List[A]]* Fill with a two parameters]]]
|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.""".stripMargin
"""For an explanation of how to resolve ambiguous links,
|see "Resolving Ambiguous Links within Scaladoc Comments" in the Scaladoc for Library Authors guide
|(https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html)""".stripMargin
} else ""

def memberLookup(pos: Position, query: String, site: Symbol): LinkTo = {
Expand Down

0 comments on commit dd33bd3

Please sign in to comment.