testcontainers / testcontainers/testcontainers-python
Improve DockerCompose documentation
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 2.3k
- Fork
- 386
- Merge trung bình
- 4 giờ 40 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
Hi. I'm starting to use testcontainers to test the behavior of a simple P2P network written in Python. I noticed that the auto-generated documentation for each class is just a copy of the constructor (without parameters descriptions) and a small code example. It would be really helpful if, at least, a small description of the behavior of each available method for each class was provided. Then this could be improved by adding a small description of the meaning of each parameter.
Small addition: for some reason, the documentation has really big margins on the left and the right but the title is too long.
Hướng dẫn đóng góp
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
Bắt đầu với tài liệu được tạo có liên kết trong issue và tìm lớp DockerCompose cùng các trang phương thức của lớp này. Xem xét cách tài liệu được tạo và định kiểu trước khi ghi lại hành vi của các phương thức và ý nghĩa của các tham số; công việc được xem là hoàn tất khi các trang giải thích các phương thức và tham số hiện có, đồng thời các lề quá lớn và tiêu đề dài được sửa.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- docker-compose, python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100