LuaLS / LuaLS/lua-language-server
Documentation doesn't contain the descriptions of classes.
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?
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
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 LuaLS CLI-Pfad, der die Dokumentation erstellt, und reproduziere das Problem anhand des dokumentierten Beispiels. Vergleiche die generierte Ausgabe mit der erwarteten Klassenbeschreibung, den Feldern und den Methoden; abgeschlossen ist die Aufgabe, wenn die Beschreibungen in der generierten Dokumentation erhalten bleiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100