Improve in-code documentation

Đang mở
#175 2 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ó
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
20/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
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 khảo sát codebase Python để tìm các pydocs còn thiếu và xem xét các PRs được đề xuất đã đề cập trong issue. Phạm vi bao gồm tài liệu và ví dụ trên gần như toàn bộ code, cùng với một policy để ngăn các PRs không có tài liệu. Để được xem là hoàn tất, cần có một cách tiếp cận đã được thống nhất và mức độ bao phủ rộng đối với phần tài liệu 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ả

enhancement

Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.

It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.

Ngôn ngữ chính
Python
Star
342
Fork
65
Không có pull request nào được merge trong 30 ngày

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

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

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 cloudevents/sdk-python

Tất cả issue của cloudevents/sdk-python

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.