reactjs / reactjs/react-docgen
The enum value of oneOf doesn't recognize description.
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
Hi,react-docgen does't recognize description for oneOf enum value.Sometimes enum value will make people so confused.It's good to show the comment in description.
Example Component
import React, { Component } from 'react'
import PropTypes from 'prop-types'
class Box extends Component {
render() {
return <div>box</div>
}
}
Box.propTypes = {
/** 排列 */
flexDirection: PropTypes.oneOf([
/** 横向 */
'row',
/** 纵向 */
'column',
]),
}
export default Box;
Output Docgen
The comment "横向, 纵向" doesn't show in description.
{
"description": "",
"displayName": "Box",
"methods": [],
"props": {
"name": {
"flexDirection": {
"defaultValue": {
"value": "'column'",
"computed": false
},
"type": {
"name": "enum",
"value": [{
"value": "'row'",
"computed": false
}, {
"value": "'column'",
"computed": false
}]
},
"required": false,
"description": "排列"
}
}
}
}
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 gemeldeten Box-Komponente und ihrem PropTypes.oneOf-Beispiel und vergleiche dann das generierte JSON mit den Inline-Kommentaren zu jedem Enum-Wert. Verfolge, wie oneOf-Werte dargestellt werden, und bestätige, dass die Ausgabe deren Beschreibungen enthält und gleichzeitig die Beschreibung auf Prop-Ebene beibehält. Fertig ist es, wenn das dokumentierte Beispiel Beschreibungen sowohl für „row“ als auch für „column“ erzeugt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100