Improve API doc for users
Đang mở
Chưa có ai nhận issue này.
Documentation
help wanted
task
- Ngôn ngữ chính
- Python
- Star
- 1.8k
- Fork
- 570
- Merge trung bình
- 1 ngày 10 giờ
- Pull request đã merge (30 ngày)
- 24
Mô tả
The problem
Just published API doc.
https://appium.github.io/python-client-sphinx/
However, it is just first revision and could be more user friendly.
References
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Trước tiên, hãy xem lại tài liệu API đã được xuất bản tại https://appium.github.io/python-client-sphinx/, sau đó so sánh tài liệu này với các ví dụ Sphinx và các tham chiếu Napoleon Config được liệt kê trong issue. Xác định những thiếu sót cụ thể đối với người dùng và cập nhật tài liệu; công việc được xem là hoàn tất khi tài liệu tham chiếu API dễ sử dụng hơn.
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ó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100