reactjs / reactjs/react-docgen
Extract comments from `defaultProps`
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 our component library, a lot of comments are historically made on defaultProps not on propTypes. It would be nice if react-docgen could catch them as well
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
Das Issue nennt keine Dateien, Tests oder keinen Einstiegspunkt. Beginne damit zu ermitteln, wie react-docgen Kommentare aus propTypes extrahiert und wie defaultProps behandelt werden, und führe dann die vorhandenen Extraction-Tests aus; abgeschlossen ist die Aufgabe, wenn Kommentare, die in defaultProps geschrieben wurden, in der generierten Komponentendokumentation enthalten sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 30/100