LuaLS / LuaLS/lua-language-server

[Feature Request] Add additional fields to exported docs

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

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Right now, it's very difficult to parse the exported docs. I've mostly been able to figure stuff out, but there's a bit of information the exported JSON file does not expose, which I would like to suggest.

  • A field for which class something originates from, to filter out unchanged methods/fields from parents
  • A relative version of file, instead of an absolute path
  • A version of the description which does not include markdown for params and return values, since those are separate
  • Whether a function is deprecated or not
  • A way to hide a field or method from the docs export (---@nodoc?)
  • Maybe a way to not export inherited fields/methods? The exported file for my project is more than a million lines long...

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, die Implementierung des exportierten Dokumentations-JSON und den Code zu finden, der Felder für Funktionen, Methoden und Felder zusammenstellt. Überprüfe, wie Vererbung, Dateipfade, Beschreibungen und Veraltung derzeit dargestellt werden; die Arbeit wäre abgeschlossen, wenn ein abgestimmter Umfang und Tests vorhanden sind, die die ausgewählten Exportfelder sowie das Verhalten von nodoc oder Vererbung abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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