LuaLS / LuaLS/lua-language-server

[Feature Request] Add additional fields to exported docs

Aperta
#2,416 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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
- [x] 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...

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando l’implementazione del JSON della documentazione esportata e il codice che assembla i campi per funzioni, metodi e campi. Esamina come vengono attualmente rappresentati l’ereditarietà, i percorsi dei file, le descrizioni e la deprecazione; il lavoro sarà completato quando saranno definiti un ambito concordato e test che coprano i campi di esportazione selezionati e il comportamento di nodoc o dell’ereditarietà.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.