reactjs / reactjs/react-docgen
Documentation for JSDoc support
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 3.8k
- Forks
- 316
- Merge moyen
- 5 h 7 min
- PR mergées (30 j)
- 4
Description
In the README there is no mention of JSDoc and what subset of JSDoc syntax react-docgen supports.
Would help to have some documentation explaining the usage with JSDoc.
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 le README et les points d’entrée de la prise en charge de JSDoc dans le dépôt. Documentez l’utilisation de JSDoc avec react-docgen et décrivez clairement le sous-ensemble de syntaxe JSDoc pris en charge, afin que les lecteurs puissent comprendre la fonctionnalité sans dépendre de la discussion de l’issue.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- react, typescript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100