Skip to content

Show documentation on hover #1006

New issue
New issue
Closed
#1025
Closed
Show documentation on hover#1006
#1025
Assignees
marvinborner
Labels
area:lspblockedBlocked on other issues / PRsdocumentationImprovements or additions to documentationquality-of-life
@jiribenes

Description

@jiribenes
jiribenes
opened on May 19, 2025

Warning

Blocked on #930

On hover, show the attached documentation to that definition:

  1. add a documentation to SymbolInfo:

effekt/effekt/shared/src/main/scala/effekt/Intelligence.scala

Lines 17 to 40 in 5ad455b

case class SymbolInfo(
symbol: Symbol,
header: String,
signature: Option[String],
description: Option[String]
) {
def fullDescription: String = {
val sig = signature.map(sig => s"```effekt\n$sig\n```").getOrElse { "" }
val desc = description.getOrElse("")
s"""|#### $header
|$sig
|$desc
|""".stripMargin
}
def shortDescription: String = {
val sig = signature.map(sig => s"```effekt\n$sig\n```").getOrElse { "" }
s"""|#### $header
|$sig
|""".stripMargin
}
}

  1. then populate it here:

effekt/effekt/shared/src/main/scala/effekt/Intelligence.scala

Line 194 in 5ad455b

def getInfoOf(sym: Symbol)(using C: Context): Option[SymbolInfo] = PartialFunction.condOpt(resolveCallTarget(sym)) {

Metadata

Metadata

Assignees

Labels

area:lspblockedBlocked on other issues / PRsdocumentationImprovements or additions to documentationquality-of-life

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions