LuaLS / LuaLS/lua-language-server
`--doc` writes lua's documentation instead of given module's
Aperta
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?
Command Line
Which OS are you using?
Windows WSL
What is the issue affecting?
Other
Expected Behaviour
Producing documentation for the given module
Actual Behaviour
Producing documentation for lua's builtin functions
Reproduction steps
- Create & cd into empty folder with a module.lua inside:
---@param x number
function foo(x) end
- Execute
lua-language-server --doc=. --doc_out_path=. - Get the doc.md & doc.json containing lua docs instead of module docs
Additional Notes
Tested on 3.13.5.
Log File
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 comando lua-language-server --doc e segui il modo in cui --doc=. e --doc_out_path=. selezionano il modulo di input e i file di output. Riproduci il problema con il file module.lua fornito, quindi verifica che doc.md e doc.json descrivano quel modulo invece delle funzioni integrate di Lua.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- lua
- Ambito
- cli, documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100