haskell / haskell/haskell-language-server

Show function argument documentation in hovers

Open
#2,348 13 comments 3 reactions 0 assignees View on GitHub
component: ghcide Hackathon level: easy type: enhancement
Dominant language
Haskell
Stars
3k
Forks
455
Avg merge
2d 19h
Merged PRs (30d)
11

Description

I'd loved to see those function "signature comments" displayed. HLS already helps to write them. I found them often being a true way of documenting what function does, as people often in function docs just white what functions accepts & does with args - people write that style way quite intuitively & that fits greatly to be a signature comments. To see those sometimes would be an immense simplification to read code.

Several years ago - I remember the dialog that Haddock-like signature comments were not yet in the LSP protocol specification.

What is the current status there (and here 8) )?

![Screenshot-2021-11-12-01:10:32](https://user-images.githubusercontent.com/20933385/141381982-3ea9b347-0ad4-437b-ad2d-ef37c67966a9.png)

As I arrived though reading `lsp-haskell` -> `lsp-ui` -> `lsp-mode` -> searching though `HLS` & looking at `Microsoft LSP specs` and seeing there as good as :bat: :dark_sunglasses: :sunglasses: :night_with_stars: :wavy_dash: :crescent_moon: :wavy_dash: & in that way I arrived here. & decided you should know something about what are the current affairs there 8)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.