python / python/cpython

Tutorial - Section 4 Has Numerous Problems

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

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

Remember, the target audience for the tutorial are people with no prior Python knowledge. Given this, there are a few problems:

  • Section 4.2: The second code example uses dictionaries but they have not been introduced - and they appear again in a bullet point in Section 4.6.
  • Section 4.2: (Same code example.) Furthermore, while users and users.copy() might make some intuitive sense, a brief explanation of what items() does seems necessary, otherwise people will think "I guess I just have to write this even though I have no idea why".
  • Section 4.6: __match_args__ is poorly introduced. It is explained that if it's set a certain way, it's possible to write patterns in a certain way but it's not made clear how to set it until the following example, which is about nesting patterns. This might lead readers to get stuck before it's even clarified.
  • Section 4.6: It seems like some of the bullet points at the end of this section were written in a rush, assume prior knowledge of Python, and do not follow the pace of the tutorial. (We've had a bunch of questions on Discord from people who essentially didn't understand anything that was written there.)

It seems like a lot of this has been copied over almost verbatim from PEP-636, which shares the same problems.

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

Mở hướng dẫn đóng góp

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 các Phần 4.2 và 4.6 của tutorial, sau đó so sánh phần tài liệu liên quan trong PEP-636. Kiểm tra rằng dictionaries và items() được giới thiệu trước khi sử dụng, rằng match_args được giải thích trước cú pháp pattern của nó, và rằng các gạch đầu dòng ở cuối có thể hiểu được đối với những người đọc chưa có kiến thức trước về Python. Được xem là hoàn tất khi có thể hiểu các phần này mà không cần những câu hỏi trên Discord được mô tả trong issue.

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ó
3/5
Thời gian dự kiến
1-2 ngày
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

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.