python / python/typing

Should we add links to existing resources?

Đang mở
#1,046 7 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

topic: documentation
Ngôn ngữ chính
Python
Star
1.8k
Fork
302
Merge trung bình
23 giờ
Pull request đã merge (30 ngày)
8

Mô tả

I was catching up on a long python-dev discussion about the state of type annotations, and noticed that @gvanrossum had asked for a list of easily discoverable (by search engines) resources regarding typing.

I collected up this note:
https://gist.github.com/stroxler/ade7977ed07e27448222a468796bc467

Would we want to include a couple of the best links (in particular the RealPython blog, maybe the LogRocket one as well) in our docs? At least at this time, those may actually be the two best getting-started tutorials. The mypy docs are much more thorough and incredibly useful as a reference, but aren't really written in a manner where a beginner could easily skim them end-to-end.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. 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 đọc gist được liên kết và tài liệu hiện có về typing, sau đó so sánh các tutorial được đề xuất của Real Python và LogRocket với tài liệu tham khảo của mypy. Xác nhận tài nguyên nào phù hợp với người mới bắt đầu và xác định trang tài liệu nơi các liên kết bên ngoài dành cho người mới bắt đầu cần được đặt. Công việc được xem là hoàn tất khi các liên kết được chọn đã được thêm kèm mô tả rõ ràng, hoặc issue ghi lại lý do không nên thêm chúng.

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
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.