CodeEditApp / CodeEditApp/CodeEdit

✨ Quick Help Inspector

Aperta
#364 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement inspector UI workspace
Lingua principale
Swift
Stelle
23k
Fork
1.2k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia individuando l’integrazione esistente di Language Server Protocol, in particolare textDocument/hover, e l’UI di inspector, outline o inline-diagnostics. Confronta questi punti di ingresso con il comportamento proposto del panel o del popover. Il lavoro è completato quando il nome, il tipo, la firma, la documentazione, le informazioni sul tipo e la posizione di definizione del simbolo corrente si aggiornano contestualmente e la documentazione mancante viene gestita correttamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
swift
Ambito
desktop, devtools
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.