x/tools/gopls: add configuration for single-line hover

[inliquid]

Right now gopls returns only first sentence from the symbol documentation, please make it return full docs.

[stamblerre]

This is intentional. Often, documentation can be lengthy and overwhelming (token.Pos is a good example), so we try to avoid showing it all on hover. My assumption was that, if the user wanted to see more detail, they could jump to the definition of the identifier.

However, if this is not the case, and other people are also interested in this behavior, I'd be willing to make this change.

If you want to see full documentation on hover, please upvote this issue or comment with your reasoning.

[inliquid]

Actually full docs on hover was available with all editors/tools that I was using so far:

• VS Code + default command line tools
• VS Code + go-langserver
• VS Code + bingo
• Goland

From my experience it's one of the most useful and demanded features. I wouldn't mind that gopls will have a config option to disable documentation on hover. Right now cutting it to first sentence is confusing and wrong because it creates wrong understanding by putting first phrase out of context and creating wrong impression for a developer that this first sentence IS the description, while it's not. It must either be full docs or no doc at all.

[marwan-at-work]

I like the small doc to not clutter everything. Before Gopls, when you hover over a signature you get a mini version of the doc (or none), but if you cmd+hover you get the full doc/definition. That was quite useful, because sometimes I just want to see the signature without having to recognize it from the docs...and sometimes I want to read the docs so I just cmd+hover

[stamblerre]

Filed microsoft/language-server-protocol#772 to get more clarity on textDocument/hover.

[stm9443]

I personally would prefer to have full comments over the single line version, but I can understand the desire to only see the signature at times. Is it possible to add a configuration that will change the length of comments that you see on hover?

Something like: showFullComments: true (default: false)

A setting like this would allow each developer to decide the style of comments they see when hovering.

[stamblerre]

That does seem like a reasonable solution while we wait on modifications to the LSP specification. I think the options should be 1) full, 2) shortened, 3) single line (to support clients like vim-go, which currently trims to a single line).

[gopherbot]

Change https://golang.org/cl/184797 mentions this issue: internal/lsp: add configuration for hover levels