AnswerDotAI / AnswerDotAI/nbdev

Render docs for methods by default

Đang mở
#293 3 bình luận 2 reaction 0 người được giao Xem trên GitHub
enhancement
Ngôn ngữ chính
Jupyter Notebook
Star
5.3k
Fork
513
Merge trung bình
2 ngày 30 phút
Pull request đã merge (30 ngày)
8

Mô tả

We should render docs for methods by default rather than requiring showdoc(...) on each method. Of course its better if people use showdoc(method) as that promotes better docs, but perhaps for people starting out it can help with initial setup?

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Không có tệp, bài kiểm thử hoặc điểm vào nào được nêu tên. Hãy bắt đầu bằng cách tìm phần triển khai và các bài kiểm thử cho showdoc(method), sau đó so sánh việc kết xuất mặc định với showdoc(...). Được xem là hoàn tất khi tài liệu phương thức được kết xuất mà không yêu cầu showdoc(...), đồng thời cách sử dụng tường minh hiện có vẫn được hỗ trợ.

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

Đánh giá

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

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.