reactjs / reactjs/react-docgen

The enum value of oneOf doesn't recognize description.

Aperta
#381 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

help wanted improvement
Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
5h 7m
PR unite (30g)
4

Descrizione

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": "排列"
      }
    }
  }
}

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dal componente Box segnalato e dal relativo esempio PropTypes.oneOf, quindi confronta il JSON generato con i commenti inline su ciascun valore dell'enum. Traccia il modo in cui vengono rappresentati i valori di oneOf e verifica che l'output includa le relative descrizioni, preservando al contempo la descrizione a livello di prop. Il lavoro è completo quando l'esempio documentato produce descrizioni sia per “row” sia per “column”.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
react, typescript
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.