microsoft / microsoft/TypeScript

Improving documentation for built-in type declarations

Abierto
#40,024 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

Looking at for instance lib.dom.d.ts, what I notice is that the documentation isn't what it could be. Is there any policy w.r.t. improving on this? I think the benefits of better docs are quite obvious, for instance adding examples or stating browser support for certain features.

However I wonder if:

  • Since the file is already quite large, and adding documentation could blow it up like 100x, would this cause any performance issues (in editors)? If so, is there a way around it?
  • The best documentation on these things (that I know of) are on MDN. A nice start could be to link/auto add some docs from there, if the licensing allows it (https://wiki.developer.mozilla.org/en-US/docs/MDN/About#Copyrights_and_licenses). I think it does at least in part.

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Comienza revisando lib.dom.d.ts y las preguntas del issue sobre el tamaño de la documentación, el rendimiento del editor y las licencias de MDN. Compara las declaraciones existentes con el material de MDN mencionado. Este issue solo estará completo después de que el proyecto acuerde una política de documentación y un enfoque concreto y aceptado.

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

Evaluación

Stack tecnológico
typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.