Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REPL: display Scaladoc #12275

Open
SethTisue opened this issue Dec 8, 2020 · 4 comments
Open

REPL: display Scaladoc #12275

SethTisue opened this issue Dec 8, 2020 · 4 comments

Comments

@SethTisue
Copy link
Member

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 SethTisue added the repl label Dec 8, 2020
@SethTisue SethTisue added this to the 2.13.5 milestone Dec 8, 2020
@SethTisue SethTisue self-assigned this Dec 8, 2020
@SethTisue SethTisue modified the milestones: 2.13.5, 2.13.6 Feb 9, 2021
@dwijnand dwijnand modified the milestones: 2.13.6, 2.13.7 May 10, 2021
@ches
Copy link

ches commented May 18, 2021

(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).

@SethTisue SethTisue modified the milestones: 2.13.7, 2.13.8 Oct 21, 2021
@SethTisue SethTisue modified the milestones: 2.13.8, 2.13.9 Dec 15, 2021
@SethTisue
Copy link
Member Author

SethTisue commented Feb 4, 2022

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 SethTisue removed their assignment Feb 4, 2022
@SethTisue
Copy link
Member Author

SethTisue commented Feb 4, 2022

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 SethTisue modified the milestones: 2.13.9, 2.13.10 Apr 25, 2022
@SethTisue SethTisue modified the milestones: 2.13.10, Backlog Sep 23, 2022
@Urthor
Copy link

Urthor commented Dec 1, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants