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

Show information when hovering a symbol #26

Open
jonas opened this issue Jun 29, 2017 · 1 comment
Open

Show information when hovering a symbol #26

jonas opened this issue Jun 29, 2017 · 1 comment

Comments

@jonas
Copy link
Collaborator

jonas commented Jun 29, 2017

By default, no information is shown when hovering a symbol. It would be nice to show at least type information by implementing the HoverProvider.

In addition, the default "show implementation" pop-up displayed when hovering and pressing Ctrl or key on Mac could also be improved by implementing the ImplementationProvider:

screen shot 2017-06-28 at 8 47 26 pm

@jonas jonas changed the title Improve definition shown when hovering a symbol Show information when hovering a symbol Jun 29, 2017
@olafurpg
Copy link
Member

olafurpg commented Jul 2, 2017

I think we can add metadoc.schema.Symbol.docstring: String, which is generated by the cli. It's possible to find the docstrings attached to each definition with the AssociatedComment helper in scalameta contrib https://github.com/scalameta/scalameta/blob/master/scalameta/contrib/shared/src/main/scala/scala/meta/contrib/AssociatedComments.scala In addition, it's possible to parse the docstrings with ScaladocParser. Note that the MarkedString emitted by the HoverProvider is rendered as markdown.

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

2 participants