Classes in go.py need to be documented

Đang mở
#1 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách mở go.py và xác định các class chính cũng như mối quan hệ giữa chúng. Thêm các docstrings mạch lạc giải thích những mối quan hệ giữa các class đó, sau đó xem xét lại file để xác nhận rằng các class chính đã được ghi tài liệu và các mối quan hệ là dễ hiểu.

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

Mô tả

We just need to get coherent docstrings into the main classes within the script. Right now, there aren't many indicators of the links between the different classes. It makes it tough to read through.

The important bit of information would be the relationships between all of them.

Ngôn ngữ chính
Python
Star
22
Fork
10
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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của f5devcentral/f5go

Tất cả issue của f5devcentral/f5go

Issue tương tự

Thêm issue về Python

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.