Ignore a type but still document its fields when embedded

Đang mở
  • Có gì không ổn?
#75 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

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

Hướng nghiên cứu

Bắt đầu bằng cách lần theo hành vi của ignoreTypes đã được thay đổi trong #73 và cách xử lý các struct nhúng được đánh dấu bằng json:",inline". Xác nhận cách các kiểu bị bỏ qua được loại trừ trong khi các trường nhúng của chúng vẫn còn trong tài liệu được tạo, sau đó thêm coverage cho trường hợp này và xác minh đầu ra được tạo.

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

Mô tả

enhancement

#73 changed (fixed) the behavior of ignoreTypes so that they are actually excluded from the output. I was previously using the ignoreTypes list to ignore types that are only embedded in other structs. The types would not receive their own section/table in the resulting docs, but their fields would still be documented when they were embedded in other structs (with json:",inline"). It would be nice if this use case could be supported in the tool.

Ngôn ngữ chính
Go
Star
176
Fork
81
Không có pull request nào được merge trong 30 ngày

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 elastic/crd-ref-docs

Tất cả issue của elastic/crd-ref-docs

Issue tương tự

Thêm issue về Go

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.