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

Wish: Type hover shows doc comment #70

Open
Rhywun opened this issue Mar 1, 2018 · 3 comments
Open

Wish: Type hover shows doc comment #70

Rhywun opened this issue Mar 1, 2018 · 3 comments
Labels

Comments

@Rhywun
Copy link

Rhywun commented Mar 1, 2018

Is it possible to display the source code's documentation comment (in addition to the type) within the popup that appears when I hover over an item in the editor? I am pretty new to Haskell so I'm not sure if this is even possible. Thank you

@martrik
Copy link
Collaborator

martrik commented May 11, 2018

Hello @Rhywun. You mean the actual Hoogle description of library functions?

@Rhywun
Copy link
Author

Rhywun commented May 11, 2018

I was thinking of the comments that begin with -- | in source code, e.g. from module GHC.Num:

-- | Unary negation.
negate              :: a -> a

But I don't see any command to show a doc comment in GHC similar to :t which shows the type, so I suspect it isn't possible.

@martrik
Copy link
Collaborator

martrik commented May 11, 2018

I see what you mean. Yes I think the comments should be fetched from the Hoogle online documentation and parsed to then be displayed. We are not actively adding features to Haskelly but we do accept MRs. So if you feel like giving it a go feel free to contribute to the project!

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

No branches or pull requests

2 participants