microsoft / microsoft/TypeScript-Website
Creating .d.ts Files from .js files : Half-broken link to "the reference here" (JSDoc)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 2.6k
- Forks
- 1.5k
- Ø Merge
- 2 T. 2 Std.
- Gemergte PRs (30 T.)
- 7
Beschreibung
The Creating .d.ts Files from .js files page's introduction reads:
With TypeScript 3.7, TypeScript added support for generating .d.ts files from JavaScript using JSDoc syntax.
This set up means you can own the editor experience of TypeScript-powered editors without porting your project to TypeScript, or having to maintain .d.ts files in your codebase. TypeScript supports most JSDoc tags, you can find the reference here.
The second link's target anchor does not exist anymore, so the link is confusing. The target page now contains the in-jsdoc-references anchor, but looking at the page quickly, it seems like what the link should really point to is the JSDoc Reference page.
By the way
- The page title's capitalization is inconsistent.
- TypeScript 3.7 was released in November 2019. The page shouldn't start with that detail, and for sure it shouldn't rely on the 3.7 release notes to document JSDoc support.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der verknüpften Seite „Creating .d.ts Files from .js files“ und prüfe ihre Einleitung zusammen mit den verknüpften JSDoc-Seiten im TypeScript Handbook. Überprüfe den defekten supported-jsdoc-Anker und aktualisiere die Referenz so, dass sie zur vorgesehenen JSDoc-Dokumentation führt; abgeschlossen ist die Aufgabe, wenn der Link zur relevanten Referenz führt und die Seite ohne defekten Anker gerendert wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 55/100