Circular dependency between `mapping` term `collections.abc.Mapping`
Chưa có ai nhận issue này.
- 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
The mapping (1) glossary term is defined as
A container object that supports arbitrary key lookups and implements the methods specified in the
collections.abc.Mappingorcollections.abc.MutableMappingabstract base classes. Examples includedict,collections.defaultdict, andcollections.Counter.
Whereas for example collections.abc.Mapping(2) and collections.abc.MutableMapping(2) have the documentation:
ABCs for read-only and mutable mappings.
I expected either the documentation on a mapping or the documentation on the ABC's to describe or link to what methods a (mutable) mapping implements. Now they refer to each other in a circle for the actual specification of what methods are required.
1: https://docs.python.org/3/glossary.html#term-mapping
2: https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping
Linked PRs
- gh-149348
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
Trước tiên, hãy xem xét PR được liên kết gh-149348, sau đó kiểm tra mục mapping trong bảng thuật ngữ và tài liệu về collections.abc.Mapping và collections.abc.MutableMapping được liên kết trong báo cáo. Cập nhật tài liệu để mô tả các phương thức mapping bắt buộc mà không để hai mục tham chiếu vòng đến nhau.
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
- 35/100