Add test that fails/warns when methods are undocumented.
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- ci-cd, documentation, testing-qa
Hướng nghiên cứu
Bắt đầu bằng cách xác định cấu hình build tài liệu của Doxygen và Sphinx, sau đó xác định nơi một bài kiểm thử Python có thể kiểm tra đầu ra của Doxygen và nơi có thể gửi các kết quả tài liệu đến CDash. Được xem là hoàn tất khi các phương thức chưa được lập tài liệu tạo ra lỗi hoặc cảnh báo trong bài kiểm thử, đồng thời các cảnh báo và lỗi khi build Sphinx hiển thị trên dashboard CDash.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
This could be done by writing a Python test that runs the Doxygen command and filters the output.
It would also be nice to "pass" warnings and errors from building the Sphinx user documentation to the CDash dashboard so that people realize when they have broken the documentation in some way.
- Ngôn ngữ chính
- C++
- Star
- 59
- Fork
- 30
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc 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.
Issue khác của Kitware/SMTK
-
pybind11 gil_scoped_acquireĐang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
-
Building smtk statically breaks session registry.Có thể làm lại được @vibraphone đã nhận 3980 ngày trước và không có pull request nào đang mở. Đang mởbug
-
Mangle third party librariesĐang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
MOAB header messĐang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 20/100
-
Clean up SMTK buildĐang mởhelp wanted
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
KhronosGroup/Vulkan-Tutorial#534 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 2 ngày
-
bug IO
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
MrNeRF/LichtFeld-Studio#3824 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
throneproj/Throne#2043 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
Perchik71/Creation-Kit-Platform-Extended#267 ·
Maintainer thường phản hồi trong vòng 1 ngày