bug icon indicating copy to clipboard operation
bug copied to clipboard

REPL: display Scaladoc

Open SethTisue opened this issue 4 years ago • 3 comments

Like the :doc command in the Scala 3 REPL. (And, does Ammonite have a version of this?)

Easy form of this improvement: display the URL of the relevant doc.

Harder form: show the actual Scaladoc in the terminal.

SethTisue avatar Dec 08 '20 22:12 SethTisue

(And, does Ammonite have a version of this?)

AFAIK it does not, it does have source() which is suggested also for the use case of viewing docs.

(Source viewing is another handy feature in Ammonite and REPLs in other languages where I've seen it, but I'll take it elsewhere since this issue has a clear and worthy focus on Scaladoc).

ches avatar May 18 '21 16:05 ches

Access to the source code is desirable as well. Perhaps it's enough to provide a link to the online Scaladoc, since the online Scaladoc then links to the source.

SethTisue avatar Feb 04 '22 18:02 SethTisue

I've removed my assignment since although I've long intended to tackle this myself, that hasn't happened. It is very much open for a volunteer.

SethTisue avatar Feb 04 '22 18:02 SethTisue

Just commenting, this is an important issue IMO.

A big, big part of my experience learning Scala is overcoming the sharpness of the learning curve for the syntax/built-ins.

An equivalent to help([1, 2, 3]) in the Python interpreter would be tremendous.

Urthor avatar Dec 01 '22 22:12 Urthor