Suppress doc build warnings
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Cython
- Star
- 3.4k
- Fork
- 329
- Merge trung bình
- 1 ngày 21 giờ
- Pull request đã merge (30 ngày)
- 113
Mô tả
According to @vzhurba01 the warnings are mostly due to the fact that some types are shared (?) across multiple modules and they are benign. Would be nice to figure out a way to suppress this particular warning, so that other warnings are not cluttered in-between and become noise.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách chạy bản build tài liệu và xác định cảnh báo được gán cho các kiểu được dùng chung giữa nhiều module. Theo dõi cách các cảnh báo được cấu hình và xác nhận rằng chỉ cảnh báo vô hại này bị suppressed, trong khi các cảnh báo khác vẫn hiển thị. Hoàn thành khi bản build tài liệu phát ra ít cảnh báo hơn mà không che giấu các cảnh báo không liên quan.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- build-system, documentation
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100