CodeEdit icon indicating copy to clipboard operation
CodeEdit copied to clipboard

✨ Quick Help Inspector

Open austincondiff opened this issue 3 years ago • 0 comments

Description

A Quick Help inspector panel would provide inline documentation and type information for the symbol currently under the cursor or selected in the editor. This allows developers to quickly understand the purpose, usage, and context of functions, types, and variables without navigating away from their current position.

Proposed Behavior

  • When a user places the cursor over a symbol, its documentation is displayed in a dedicated inspector panel.
  • The panel could include:
    • Symbol name and kind (e.g., function, variable, type)
    • Declaration signature
    • Documentation comments
    • Type information
    • Module or file where the symbol is defined
  • The panel updates contextually as the user moves the cursor or selects a new symbol.

Implementation Notes

  • Can be powered by existing Language Server Protocol (LSP) support using textDocument/hover and related requests.
  • Could be placed in the inspector area or presented as a popover or sidebar panel.
  • Should gracefully handle cases where no documentation is available.

Benefits

  • Improves developer productivity by reducing context-switching.
  • Helps with onboarding and working in unfamiliar codebases.
  • Provides fast, integrated access to symbol documentation and type hints.

Additional Context

This is a common feature in modern development environments and would be a natural addition alongside outline views and inline diagnostics.

austincondiff avatar Apr 01 '22 08:04 austincondiff

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar May 31 '22 09:05 stale[bot]

Keep

austincondiff avatar May 31 '22 14:05 austincondiff