LuaLS / LuaLS/lua-language-server
Documentation export is missing information
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
What is the issue affecting?
Other
Expected Behaviour
After generating documentation with --doc, I expected to have access to the all of the information available in the annotations that is presented or used by the language server.
Actual Behaviour
There were a few things that are missing or strange:
@seeannotations are absent.- Access levels (
@protected,@private,@package) are absent. - Aliases that extend other aliases include the documentation of the alias that they extend, which makes it difficult to tell which documentation belongs to only the extended alias.
- The
startandfinishfields seem odd; they're very large numbers (e.g., 5490009, 5490021) that clearly don't refer to character ranges within the files. What are these numbers?
For the purpose of generating documentation, the first two problems seem significant—it would be difficult to filter out private fields and methods, for example.
Reproduction steps
- Create a Lua file that uses access modifiers,
@see, and an alias that extends another alias. I've provided a minimal example of such a file below. - Observe the missing data and oddities.
Additional Notes
Example for reproduction:
---@class C
---@field private z integer
local C = {}
---Base alias doc comment.
---@alias Base
---| 'A'
---| 'B'
---Extended alias doc comment.
---@alias Derived
---| Base
---| 'C'
---@protected
function C.x()
end
---@see C.x
function C.y()
end
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
Führe zunächst den --doc-Export für die Lua-Reproduktion im Issue aus und untersuche, wie dessen Ausgabe @see, Zugriffsmodifikatoren, geerbte Alias-Dokumentation und start/finish darstellt. Verfolge den Einstiegspunkt des Dokumentationsexports und vergleiche dessen Ausgabe mit den vom Language Server verwendeten Annotation-Informationen. Als erledigt gilt die Aufgabe, wenn die exportierten Daten die angeforderten Annotation-Details bewahren und die Bereichswerte erklären oder korrigieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- documentation, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100