reactjs / reactjs/react-docgen
Documentation for JSDoc support
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.8k
- Forks
- 316
- Ø Merge
- 5 Std. 7 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der README und den Einstiegspunkten für die JSDoc-Unterstützung im Repository. Dokumentiere, wie JSDoc mit react-docgen verwendet wird, und beschreibe klar die unterstützte Teilmenge der JSDoc-Syntax, damit Leser die Funktion verstehen können, ohne auf die Diskussion im Issue angewiesen zu sein.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100