webcomponents / webcomponents/webcomponents.org
document properties from getter @type
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 385
- Fork
- 80
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
According to https://github.com/jsdoc3/jsdoc/issues/973, the right way to document getter/setter pairs is to document one of the two with a @type
It would be great if webcomponents.org would show types based on that comment.
Please see https://www.webcomponents.org/element/@power-elements/lazy-image/1.2.1/elements/lazy-image for an example of an element which documents getters that way. Property names and descriptions are shown, but types are shown as ?
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 tracciando il modo in cui webcomponents.org estrae e visualizza i tipi delle proprietà dalla documentazione getter/setter, usando come riferimenti l’esempio @power-elements/lazy-image e la discussione JSDoc collegata. Il lavoro è completo quando le proprietà getter documentate con @type mostrano i loro tipi invece di ?.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100