Add :doc command in REPL to show documentation
#4669
Conversation
Duhemm
force-pushed
the
topic/tasty-doc-repl
branch
from
8471974 to
d86c3b0
Compare
This command is used to display the documentation associated to the
given expression. For instance:
```scala
scala> /** A class */ class A
scala> /** An object */ object O { /** A def */ def foo = 0 }
scala> :doc new A
/** A class */
scala> :doc O
/** An object */
scala> :doc O.foo
/** A def */
```
Duhemm
force-pushed
the
topic/tasty-doc-repl
branch
from
d86c3b0 to
6fb9c64
Compare
| implicit val ctx: Context = state.context | ||
|
|
||
| /** Extract the (possibly) documented symbol from `tree` */ | ||
| def extractSymbol(tree: tpd.Tree): Symbol = { |
There was a problem hiding this comment.
Can you explain why this is needed? Can you give an example
| if (stat.tpe.isError) stat.tpe.show | ||
| else { | ||
| val doc = | ||
| ctx.docCtx.flatMap { docCtx => |
There was a problem hiding this comment.
I believe in the REPL we should always have a docCtx
| * Return also the symbols that `symbol` overrides`. | ||
| */ | ||
| def pickSymbols(symbol: Symbol): Iterator[Symbol] = { | ||
| val selectedSymbol = { |
There was a problem hiding this comment.
nitpick: unnecessary braces
| } | ||
|
|
||
| typeCheck(expr).map { | ||
| case v @ ValDef(_, _, Block(stats, _)) if stats.nonEmpty => |
There was a problem hiding this comment.
Can you maybe change typeOf to return a Result[Type] and use typeOf instead of typeCheck
There was a problem hiding this comment.
We're not interested in getting the type of the expression, but rather the typed AST so that we can extract the symbol that we're interested in from it:
scala> /** bar */ def foo: Int = 2
scala> :doc foo // prints: /** bar */
I want to get the symbol of foo so that I can retrieve its documentation; I don't care about its type here.
| * Adapt `symbol` so that we get the one that holds the documentation. | ||
| * Return also the symbols that `symbol` overrides`. | ||
| */ | ||
| def pickSymbols(symbol: Symbol): Iterator[Symbol] = { |
There was a problem hiding this comment.
Why is this needed in the REPL but not the IDE? In the IDE you do:
val symbol = Interactive.enclosingSourceSymbol(trees, pos)
val docComment = ctx.docCtx.flatMap(_.docstring(symbol))|
|
||
| @Test def docOfInherited = | ||
| fromInitialState { implicit s => run("class C { /** doc */ def foo = 0 }") } | ||
| .andThen { implicit s => run("object O extends C") } |
There was a problem hiding this comment.
same (use a single run)
| |/** doc1 */ def foo(x: String): String = x + "foo" | ||
| |}""".stripMargin) | ||
| } | ||
| .andThen { implicit s => |
There was a problem hiding this comment.
same (use a single run)
| assertEquals("/** doc0 */", storedOutput().trim) | ||
| s | ||
| } | ||
| .andThen { implicit s => |
There was a problem hiding this comment.
same (merge andThen block)
| | abstract class Companion { /** doc0 */ def bar: Int } | ||
| | /** companion */ def foo: Companion | ||
| |}""".stripMargin) | ||
| .andThen { implicit s => |
There was a problem hiding this comment.
same (use a single run)
| assertEquals("/** companion */", storedOutput().trim) | ||
| s | ||
| } | ||
| .andThen { implicit s => |
There was a problem hiding this comment.
same (merge andThen block)
Depends on #4461 and #4648
This command is used to display the documentation associated to the
given expression. For instance:
(Only the last 2 commits are relevant for this PR)