LuaLS / LuaLS/lua-language-server
Additional blank lines are added to parameter descriptions in type annotations
Nessuno ha ancora preso questa issue.
- Lingua principale
- Lua
- Stelle
- 4.4k
- Fork
- 442
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
How are you using the lua-language-server?
NeoVim
Which OS are you using?
MacOS
What is the issue affecting?
Hover
Expected Behaviour
For multiline descriptions in @param annotations to be displayed as if they were in a single line.
Actual Behaviour
When the description in a @param annotation spans multiple lines, a linebreak in inserted in the Markdown response, which breaks syntax highlighting:
Even after removing the preceding whitespace in the example above, formatting is still off:
Reproduction steps
- Create a
luafile with the following content:
---@param bar any This is the description
--- for bar.
local function foo(bar) end
- Hover over
foo. - Notice the broken highlighting/formatting in the description of
bar.
Additional Notes
Although VS Code doesn't have additional syntax highlighting, do note how the font style in explanation above) changes, which suggests that the issue is reproducible outside Neovim:
Log File
No response
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Riproduci il problema a partire dall’esempio Lua fornito passando con il cursore sopra foo in NeoVim o VS Code. Parti dalla risposta di hover e dal percorso di formattazione per le descrizioni @param su più righe; il lavoro è completato quando la descrizione viene resa su una sola riga senza interrompere l’evidenziazione della sintassi Markdown in entrambi gli ambienti segnalati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- lua
- Ambito
- tooling
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 45/100