Add a tool to count and report the missing docstrings
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
- 30/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ệ
- python
- Lĩnh vực
- documentation, tooling
Hướng nghiên cứu
Bắt đầu bằng cách xem xét các triển khai Element và GDScriptClass hiện có để xác định cách báo cáo thông tin tài liệu. Sau đó, xác định trách nhiệm về đầu vào và logging của module mới; được coi là hoàn thành khi module tạo ra một bảng hiển thị tiến độ tài liệu và các docstring còn thiếu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
We could have a tool similar to Godot's doctool, that gives a table with the docs progress and missing docstrings.
We can add methods on Element and GDScriptClass to report that information easily. Then, a new module should take care of reading and logging that information.
- Ngôn ngữ chính
- Python
- Star
- 297
- Fork
- 26
- 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
Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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 GDQuest/gdscript-docs-maker
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 38/100
GDQuest/gdscript-docs-maker#95 · 4 bình luận · 1 reaction ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
-
enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 55/100
GDQuest/gdscript-docs-maker#86 · 1 reaction ·
-
index is being generated blankĐang mởbug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
GDQuest/gdscript-docs-maker#71 · 3 bình luận ·
Tất cả issue của GDQuest/gdscript-docs-maker
Issue tương tự
-
good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
vllm-project/vllm-metal#822 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
vector-store
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 90/100
mem0ai/mem0#7461 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[Bug]: chunk_span_bounds and _validated_chunk_spans reject Pydantic models ChunkSpan and AudioFileĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
BasedHardware/omi#19047 ·
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 88/100
Maintainer thường phản hồi trong vòng 1 ngày