python / python/cpython

Tutorial - Section 4 Has Numerous Problems

未關閉
#119,997 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

docs
主要語言
Python
星號
77.2k
分支
35.9k
PR 合併指標
PR 指標待擷取

描述

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.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

先閱讀教學的第 4.2 和 4.6 節,然後將相關內容與 PEP-636 進行比較。檢查 dictionaries 和 items() 是否在使用前介紹,match_args 是否在其模式語法之前得到解釋,以及結尾的項目符號是否能讓沒有 Python 先備知識的讀者理解。讀者無需提出 issue 中所述的 Discord 問題即可理解這些章節,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。