flux-lsp icon indicating copy to clipboard operation
flux-lsp copied to clipboard

The hover interaction should show short form docs

Open rockstar opened this issue 2 years ago • 1 comments

Right now, the hover information shows type information. In many cases, this type information is hyper-technical, and not so helpful. The best solution for hover information is probably the docs, and specifically the short-form docs.

DOD:

  • textDocument/hover provides short form docs on functions.

Stretch:

  • Providing a link to the long form docs is a great idea, but some clients may have problems rendering hyperlinks. Check that before adding more text than necessary.

rockstar avatar May 27 '22 21:05 rockstar

The PackageExports that is embedded in the flux crate now contains the comments for each export which should be usable to display the docs https://github.com/influxdata/flux/pull/4774

Marwes avatar Aug 25 '22 16:08 Marwes