Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

The enum value of oneOf doesn't recognize description.

Đang mở
#381 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
react, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với component Box được báo cáo và ví dụ PropTypes.oneOf của nó, sau đó so sánh JSON được tạo với các chú thích inline trên từng giá trị enum. Theo dõi cách các giá trị oneOf được biểu diễn và xác nhận rằng đầu ra bao gồm mô tả của chúng, đồng thời giữ nguyên mô tả ở cấp prop. Hoàn tất khi ví dụ được ghi trong tài liệu tạo ra mô tả cho cả “row” và “column”.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

help wanted improvement

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": "排列"
      }
    }
  }
}
Ngôn ngữ chính
TypeScript
Star
3.8k
Fork
316
Merge trung bình
3 giờ 28 phút
Pull request đã merge (30 ngày)
6

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của reactjs/react-docgen

Tất cả issue của reactjs/react-docgen

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.