allenai / allenai/allenact

Improve inline documentation for primary abstractions

Đang mở
#123 0 bình luận 0 reaction 2 người được giao Được @klemenkotar nhận Xem trên GitHub
documentation
Ngôn ngữ chính
Python
Star
383
Fork
59
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

## Problem

All of our primary abstractions should have good documentation and be fully typed.

## Solution

Go through all of these critical files and ensure that:

1. All classes/methods/modules have doc strings and these doc strings enumerate all the parameters if relevant.
2. All (except in rare cases where doing so would be highly unpractical) parameters are typed.

## Dependencies

None

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

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

Đánh giá

Issue này chưa được đánh giá.

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.