LuaLS / LuaLS/lua-language-server

Request for ability to skip adding to documentation, i.e. `---@nodoc`

Offen
#2,199 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

At the moment, if I do anything that references _G, all of the documentation for _G populates the documentation. It would be nice to be able to prevent superfluous documentation - especially for stuff that's only local to the file and not exported for public use.

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

Beginne damit nachzuverfolgen, wie Dokumentation erfasst wird, wenn eine Datei auf _G verweist, und ermittle anschließend, an welcher Stelle ein ---@nodoc-Marker erkannt werden könnte. Als erledigt gilt die Aufgabe, wenn lokale oder anderweitig nicht öffentliche Symbole aus der generierten Dokumentation ausgeschlossen werden können, ohne die Dokumentation öffentlicher Symbole zu entfernen; in diesem Issue werden keine Dateien oder Tests genannt, daher müssen diese Einstiegspunkte zuerst gefunden werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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