LuaLS / LuaLS/lua-language-server
@see annotaton duplicates documentation when using with @class
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?
Windows
What is the issue affecting?
Annotations
Expected Behaviour
I'm trying to add some @see tags to my @class
Actual Behaviour
When hovering class in editor, displayed documentation is printed twice.
Reproduction steps
Here is basic code sample. Hovering or typing class1 causes issue with displayed documentation
--- some class dock
---
---@class C2
local class2 = {}
--- another class dock here
---
---@see C2
---@class C1
local class1 = {}
---@type C1
local class1_instance = class1
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 der bereitgestellten Lua-Reproduktion im Issue und vergleiche die Hover-Ergebnisse für C1 mit und ohne die @see-C2-Annotation. Da keine Repository-Datei oder kein Test benannt ist, ermittle die vom Language Server verwendete Verarbeitung von Annotationen und Klassendokumentation und überprüfe anschließend, dass die Dokumentation von C1 einmal angezeigt wird, während die @see-Referenz weiterhin verfügbar bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- devtools
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100