Add a documentation class instead of a formatted string.
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
Hướng nghiên cứu
Không có tệp hoặc bài kiểm thử nào được nêu tên. Hãy bắt đầu bằng cách truy vết nơi các chuỗi tài liệu của hàm được định nghĩa, phân tích và sử dụng; xác định các trường hiện đang được mã hóa trong định dạng. Công việc được coi là hoàn tất khi tài liệu được biểu diễn bằng một class có các trường như mô tả, kiểu trả về, đối số và tên, tất cả các consumer hiện có được cập nhật và được bao phủ bởi các bài kiểm thử liên quan của dự án.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
CMDHELPER-2915 - Reported by ACzChef
Right now functions have to pass in a string for their docs, that then later gets parsed into usable data.
My suggestion is to have a documentation class where you just define all the fields such as description, return type, arguments, name, etc. and use that instead. It would be cleaner, and less error prone.
- Ngôn ngữ chính
- Java
- Star
- 128
- Fork
- 70
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
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 EngineHub/CommandHelper
-
discussion wanted documentation
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
EngineHub/CommandHelper#1403 ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
EngineHub/CommandHelper#1370 · 1 bình luận ·
-
bug
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
EngineHub/CommandHelper#1354 ·
-
bug
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
EngineHub/CommandHelper#1349 · 3 bình luận ·
-
bug
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
EngineHub/CommandHelper#1341 · 2 bình luận ·
Tất cả issue của EngineHub/CommandHelper
Issue tương tự
-
certification
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 80/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
[BUG] ECR GetAuthorizationToken returns a proxyEndpoint for the default region, not the request's Đang mởbug ecr
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Needs: Triage Type: Feature request
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
AntennaPod/AntennaPod#8794 ·
-
agentic-workflows
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
github/copilot-sdk#2760 ·