Tutorial - Section 4 Has Numerous Problems
オープン
まだ誰も着手していません。
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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずチュートリアルのセクション 4.2 と 4.6 を読み、次に PEP-636 の関連資料と比較してください。dictionaries と items() が使用前に導入されていること、match_args がそのパターン構文より前に説明されていること、そして最後の箇条書きが Python の予備知識のない読者にも理解できることを確認してください。これらのセクションが、issue に記載された Discord での質問なしに理解できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100