Improve readability of annotation syntaxes
Nessuno ha ancora preso questa issue.
- Lingua principale
- MDX
- Stelle
- 10
- Fork
- 19
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The [method currently used](http://localhost:3000/wiki/annotations/#understanding-this-page) for describing how to use annotations can be easy to understand at times:
`---@type `
And also impossible for mere mortals to understand:
`---@cast [+|-][, [+|-]...]`
`---@overload fun([param: type[, param: type...]]): [return_value[,return_value]]`
There must be a better way to represent these more complex syntaxes while also not using symbols regularly in use (`<`, `>`, `(`, `)`, `[`, `]`, `{`, `}`, `@`, `#`, `-`, `+`, `=`, `:`, `"`, `,`, `.`, `?`). Although now that I have listed some in-use symbols, I realize we really are quite limited. It is hard to explain a syntax that uses many symbols… using symbols.
I'm open to any suggestions on how this can be improved 🙂
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla pagina collegata annotations/#understanding-this-page e esamina gli esempi di sintassi complessa mostrati nell’issue. L’issue non definisce una sostituzione preferita né un test chiaro per determinare il completamento; per considerare il lavoro concluso sarebbe necessario concordare una notazione più leggibile e aggiornare gli esempi della documentazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100