Improve the frozenset.is(sub|super)set docstrings
Đ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ả
Documentation
RE: Documentation provided by built-in function help()
While reviewing built-in methods in detail I made note of:
- "help(frozenset)" issubset and issuperset methods both return bool type
Other comments that were not issues
See https://github.com/python/cpython/issues/129622#issuecomment-2633394435.
- "help(slice)" third parameter typo
- "help(range)" third parameter typo
- "help(float)" quizzical hex method example
- "help(bool)" is bit_length method also for absolute value of self?
- "help(bool)" is_integer appears duck-like compatible with int (TypeError with float)
- "help(bool)" from_bytes appears to return a bool from byte array
Regards,
'EntryLevelJobSeeker'
Linked PRs
- gh-129637
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 bằng cách chạy help(frozenset) và xem lại các docstring của issubset và issuperset trong mã nguồn CPython. So sánh cách diễn đạt của chúng với hành vi trả về bool của các phương thức; tài liệu được hoàn tất khi cả hai docstring mô tả chính xác kết quả đó. PR được liên kết gh-129637 cho biết công việc này đã được tiến hành.
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ó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- 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
- 25/100