LuaLS / LuaLS/lua-language-server
Documentation doesn't contain the descriptions of classes.
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?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Linux
What is the issue affecting?
Other
Expected Behaviour
Example input:
Expecting output like:
#Action
<fields & methods>
Actual Behaviour
Example output:
Here's what I see when mousing over it in VSCode:
Reproduction steps
Build docs using LuaLSP's CLI, see that descriptions get stripped/not output.
Additional Notes
No response
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
Inizia con il percorso LuaLS CLI che genera la documentazione e riproduci il problema utilizzando l’esempio documentato. Confronta l’output generato con la descrizione prevista della classe, dei campi e dei metodi; il lavoro è completato quando le descrizioni vengono mantenute nella documentazione generata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- lua
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100