diff options
author | Felix Mulder <felix.mulder@gmail.com> | 2016-10-25 19:19:07 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-10-25 19:19:07 +0200 |
commit | f57086d07f0f748830ff8506e7719e339873283d (patch) | |
tree | afcb889cbb7904eea06ffce19bcd55547b7d3b65 /src/dotty/tools/dotc/reporting/diagnostic/messages.scala | |
parent | e41393d78b68364596ebb2bd2702418beac8fd6d (diff) | |
parent | 97b0af746ac3f2eb2fe7078b5aa5d596439fbfb5 (diff) | |
download | dotty-f57086d07f0f748830ff8506e7719e339873283d.tar.gz dotty-f57086d07f0f748830ff8506e7719e339873283d.tar.bz2 dotty-f57086d07f0f748830ff8506e7719e339873283d.zip |
Merge pull request #1621 from thiagoandrade6/feature/error-messages
Add error message - Comments.scala:128
Diffstat (limited to 'src/dotty/tools/dotc/reporting/diagnostic/messages.scala')
-rw-r--r-- | src/dotty/tools/dotc/reporting/diagnostic/messages.scala | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/src/dotty/tools/dotc/reporting/diagnostic/messages.scala b/src/dotty/tools/dotc/reporting/diagnostic/messages.scala index 303ab0437..b0ce5b132 100644 --- a/src/dotty/tools/dotc/reporting/diagnostic/messages.scala +++ b/src/dotty/tools/dotc/reporting/diagnostic/messages.scala @@ -543,5 +543,42 @@ object messages { | |""".stripMargin } - + + case class ProperDefinitionNotFound()(implicit ctx: Context) extends Message(20) { + val kind = "Definition Not Found" + val msg = hl"""|Proper definition was not found in ${"@usecase"}""" + + val noUsecase = "def map[B, That](f: A => B)(implicit bf: CanBuildFrom[List[A], B, That]): That" + + val usecase = + """|/** Map from List[A] => List[B] + | * + | * @usecase def map[B](f: A => B): List[B] + | */ + |def map[B, That](f: A => B)(implicit bf: CanBuildFrom[List[A], B, That]): That""".stripMargin + + val explanation = { + hl"""|${"@usecase"} are only supported for ${"def"}s. They exist because with Scala's + |advanced type-system, we sometimes end up with seemingly scary signatures. + | + |Let's see an example using the `map`function: + | + |${"List(1, 2, 3).map(2 * _) // res: List(2, 4, 6)"} + | + |It's very straight forward to understand and use, but has such a scary signature: + | + |$noUsecase + | + |In order to mitigate this and ease the usage of such functions we have the ${"@usecase"} + |annotation for docstrings. Which can be used like this: + | + |$usecase + | + |Now when creating the docs, the method signature is substituted by the + |${"@usecase"} with a reader-friendly version. The compiler makes sure that it is valid. + | + |Because of this, you must use ${"def"} when defining ${"@usecase"}.""".stripMargin + } + } + } |