aai-institute / aai-institute/pyDVL

The glossary makes the methods page redundant?

Đang mở Phù hợp với người mới
#547 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation
Ngôn ngữ chính
Python
Star
146
Fork
10
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

The new Glossary page makes the Methods page a bit redundant because it contains descriptions of some of the methods as well as links to the implementations. Perhaps we can keep method descriptions in Methods and only put other terms in the Glossary.

_Originally posted by @AnesBenmerzoug in https://github.com/aai-institute/pyDVL/issues/537#issuecomment-2016601355_

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

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

Hướng nghiên cứu

Xem các trang Glossary và Methods trong tài liệu để xem những thuật ngữ và mô tả phương thức nào trùng lặp. So sánh nội dung để quyết định nội dung nào nên giữ lại trong Methods và nội dung nào nên chuyển sang Glossary. Kiểm tra cấu trúc tài liệu để hiểu các trang được liên kết và duy trì như thế nào.

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

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
65/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.