Improve documentation of SSL module
Đang mở
Chưa có ai nhận issue này.
docs
topic-SSL
- 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ả
This is an umbrella issue for the points raised in https://github.com/python/cpython/pull/138269#discussion_r2328597995 that I will restate below:
- Indicate positional-only parameters in SSL docs.
- Indicate which OpenSSL version is required for a given functionality.
- Reword some English if needed (I don't know if it's needed but maybe).
- Fix Sphinx references warnings.
cc @ronf
Linked PRs
- gh-138639
- gh-138646 (held for now, can wait)
- gh-138647 (held for now, can wait)
- gh-138648
- gh-138656
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 các điểm trong tài liệu SSL và phần thảo luận trong PR 138269, sau đó xem xét các PR được liên kết 138639, 138646, 138647, 138648 và 138656. Công việc được xem là hoàn tất khi giải quyết được câu hỏi còn lại về cách diễn đạt bằng tiếng Anh và hoàn thành checklist tài liệu mà không để lại cảnh báo tham chiếu của Sphinx.
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
- 20/100