microsoft / microsoft/TypeScript
Documentation: Clarify declaration files and the declare keyword
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
TypeScript Version: 2.8.0
Search Terms:
document declaration files
** Issue**
It doesn't look like you actually define what a declaration file is in your documentation. For instance, your introduction to these at https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html tells me you're going to help me learn how to write them, but not what they are or why I'd want one. But, I don't think this makes it easy for a newbie to understand.
Similarly, you don't seem to explain when the declare keyword is, or when it should be used (as far as I can tell, it is used when you need to tell the compiler that the module/library/whatever has a value of some type).
You also seem to make some references to the global namespace (declare global { ... })), but don't seem to directly explain it anywhere.
Code
n/a
Expected behavior:
n/a
Actual behavior:
n/a
Playground Link:
n/a
Related Issues:
n/a
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la introducción a los declaration files en https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html y sigue sus referencias a declare global y a las directrices relacionadas con los declaration files. Revisa el material circundante del handbook antes de editar. Se considera terminado cuando la documentación define claramente los declaration files, explica por qué y cuándo usar declare, y explica directamente el namespace global.
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
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100