Visitar URL original
Wish: Type hover shows doc comment · Issue #70 · haskelly-dev/Haskelly · GitHub
Skip to content

Wish: Type hover shows doc comment #70

Open

Description

@Rhywun

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

Activity

  1. martrik commented on May 11, 2018

    @martrik
    Collaborator

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

  2. Rhywun commented on May 11, 2018

    @Rhywun
    Author

    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.

  3. martrik commented on May 11, 2018

    @martrik
    Collaborator

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions