`_CallableGenericAlias` class and `typing.Callable` docstring should be corrected
Đang mở
Chưa có ai nhận issue này.
docs
topic-typing
- 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
*Notes:
- Python 3.14.3
- Related: #145577
_CallableGenericAlias class should be corrected for example:
Represent `Callable[argtypes, resulttype]`. -> Represent `Callable[paramtypes, returntype]`.
t_args, t_result = args -> t_params, t_return = args
typing.Callable docstring should be corrected for example:
a function that takes a single parameter -> a function that has a single parameter
... to indicate optional or keyword arguments; -> ... to indicate optional or keyword parameters;
Linked PRs
- gh-145598
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 tìm _CallableGenericAlias và docstring của typing.Callable trong phần triển khai typing của CPython. Đối chiếu cách diễn đạt với các ví dụ trong issue, sau đó xác minh rằng cả hai mô tả đều sử dụng thuật ngữ được yêu cầu cho tham số và giá trị trả về; lưu ý rằng issue có tham chiếu đến PR được liên kết gh-145598.
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