Doc README omits some documentation make targets
Đang mở
Chưa có ai nhận issue này.
docs
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 35.9k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
Doc/README.rst lists the available documentation make targets, but it does not mention texinfo, doctest, or gettext.
These targets are defined in Doc/Makefile, so the README target list can be updated to be more complete for contributors reading the documentation build instructions.
Linked PRs
- gh-151832
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
So sánh danh sách target trong Doc/README.rst với các target được định nghĩa trong Doc/Makefile, bắt đầu với các tệp đó. Cập nhật README để đề cập đến texinfo, doctest và gettext, sau đó xác minh rằng danh sách được ghi trong tài liệu khớp với các target hiện có.
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ó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 25/100