documentationjs / documentationjs/documentation

Links for types from other modules

Aperta
#64 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
JavaScript
Stelle
5.8k
Fork
481
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

If I `@returns {boolean}` I get a nice link to the documentation for booleans.

However, if I `@returns {BigInteger}` I don't get a link because `documentation` doesn't know what it is (though it might be able to infer it by seeing that there's a BigInteger variable that's `require`d from a node module and use the homepage from its `package.json` for the URL)...

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando come la documentazione risolve i tipi integrati come boolean e gestisce i nomi non risolti come BigInteger. Verifica se un modulo Node richiesto e i metadati homepage del relativo package.json possono fornire un URL di destinazione; il lavoro è completo quando i tipi di external-module vengono risolti in link utili alla documentazione senza rompere i link ai tipi esistenti.

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

Valutazione

Stack tecnologico
javascript
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.