microsoft / microsoft/TypeScript-Website

Creating .d.ts Files from .js files : Half-broken link to "the reference here" (JSDoc)

Aperta
#3,214 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
2.6k
Fork
1.5k
Merge medio
2g 2h
PR unite (30g)
7

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla pagina collegata Creating .d.ts Files from .js files ed esamina la relativa introduzione insieme alle pagine JSDoc collegate del TypeScript Handbook. Verifica l’ancora non funzionante supported-jsdoc e aggiorna il riferimento in modo che raggiunga la documentazione JSDoc prevista; il lavoro è completato quando il link risolve al riferimento pertinente e la pagina viene renderizzata senza un’ancora non funzionante.

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

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.