Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
#3,214 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

Comienza con la página enlazada Creating .d.ts Files from .js files e inspecciona su introducción junto con las páginas enlazadas de JSDoc del TypeScript Handbook. Verifica el ancla rota supported-jsdoc y actualiza la referencia para que llegue a la documentación de JSDoc prevista; el trabajo estará terminado cuando el enlace resuelva a la referencia pertinente y la página se renderice sin un ancla rota.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
TypeScript
Estrellas
2.6k
Forks
1.5k
Merge medio
2 d 12 h
PR fusionados (30 d)
8

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de microsoft/TypeScript-Website

Todos los issues de microsoft/TypeScript-Website

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.