Tutorial - Section 4 Has Numerous Problems
未关闭
还没有人认领这个 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
usersandusers.copy()might make some intuitive sense, a brief explanation of whatitems()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.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 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