microsoft / microsoft/TypeScript
Show documentation for literals in intellisense
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Suggestion
When filling in a value where the expected type is a union of literals, intellisense is able to suggest the possible values.
However, it does NOT show the documentation associated with each literal:
This makes me tend to use enums instead, which has a more verbose syntax and requires an extra import.
Use Cases
Building and documented APIs in typescript will be nicer if we could just document the literals in a union.
Search Terms
- intellisense for string literals
- documentation for string literals
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
Empieza reproduciendo la finalización de IntelliSense para una unión de literales de cadena documentados en TypeScript. Sigue el comportamiento de finalización y documentación de las sugerencias de literales y, después, verifica que cada literal sugerido muestre su documentación asociada sin cambiar el comportamiento de enum.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- developer-experience, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100