documentationjs / documentationjs/documentation

Links for types from other modules

Offen
#64 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
JavaScript
Sterne
5.8k
Forks
481
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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)...

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der Untersuchung, wie die Dokumentation integrierte Typen wie boolean auflöst und nicht aufgelöste Namen wie BigInteger behandelt. Prüfe, ob ein erforderliches Node-Modul und die Homepage-Metadaten seiner package.json eine Ziel-URL bereitstellen können; abgeschlossen ist die Aufgabe, wenn Typen aus external-module auf nützliche Dokumentationslinks aufgelöst werden, ohne bestehende Typ-Links zu beschädigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.