LuaLS / LuaLS/lua-language-server
`--doc` writes lua's documentation instead of given module's
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lua
- Sterne
- 4.4k
- Forks
- 442
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Befehl lua-language-server --doc und verfolge nach, wie --doc=. und --doc_out_path=. das Eingabemodul und die Ausgabedateien auswählen. Reproduziere das Problem mit der bereitgestellten Datei module.lua und überprüfe anschließend, dass doc.md und doc.json dieses Modul statt der integrierten Funktionen von Lua beschreiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- cli, documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100