LuaLS / LuaLS/lua-language-server

Can't export documentation for functions

Offen
#2,015 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Lua
Sterne
4.4k
Forks
442
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

I created a file with this content:

-- Test comment.
---@param x number
---@return number
return function(x)
  return x*2
end

Then I tried to export documentation from that file following this instruction, but got empty files in the output.

Classes are exported successfully, but how to export functions I do not understand.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der Export Documentation-Wiki-Anleitung und reproduzieren Sie das Problem mithilfe des Lua-Beispiels im Bericht. Vergleichen Sie den Fall mit der Funktion mit dem erfolgreich exportierten Klassenfall und ermitteln Sie, warum die Ausgabedateien leer sind; abgeschlossen ist die Aufgabe, wenn dokumentierte Funktionen nichtleere exportierte Ausgaben erzeugen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
documentation, tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.