microsoft / microsoft/TypeScript
Show documentation for literals in intellisense
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par reproduire la complétion IntelliSense pour une union de littéraux de chaîne documentés dans TypeScript. Suivez ensuite le comportement de complétion et de documentation pour les suggestions de littéraux, puis vérifiez que chaque littéral suggéré affiche sa documentation associée sans modifier le comportement de enum.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- developer-experience, tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100