microsoft / microsoft/TypeScript
Quick info for parameter redundantly shows @param tag
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
TypeScript Version: 3.1.0-dev.20180830
Code
/**
* @param p
* Once upon a time there was a parameter named p.
* P lived in a function called f.
* Then a big bad wolf came and blew f down.
*/
function f(p: number): void {}
Expected behavior:
Documentation for p is shown only once.
Actual behavior:
Documentation is shown twice -- once as the normal documentation (good), once as documentation for the @param tag which is redundant since we took the documentation from there. This doubles the size of the quick info.

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 la reproduction TypeScript 3.1.0-dev.20180830 : inspectez quick info pour le paramètre p lorsque son JSDoc contient une balise @param. Confirmez que la sortie actuelle répète la documentation du paramètre, puis vérifiez que quick info présente la documentation une seule fois sans modifier les autres comportements de JSDoc.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- developer-experience
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 48/100