LuaLS / LuaLS/lua-language-server

How to annotate default arguments to parameters

Aperta
#2,959 3 commenti 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

Is there a standard way to annotate default arguments? I believe in LDoc you can do:

-- @string[opt='gregorian'] calendar optional calendar
-- @int[opt=0] offset optional offset

I'm currently converting some docs over and couldn't find anything in the wiki.

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 dal wiki del progetto e dalla documentazione esistente sulle annotazioni, quindi confronta la sintassi supportata con gli esempi LDoc nell'issue. Documenta il modo standard di esprimere gli argomenti predefiniti, oppure chiarisci che la sintassi non è supportata, così che gli utenti che convertono la documentazione possano determinare l'annotazione corretta.

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

Valutazione

Stack tecnologico
lua
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.