- https://github.com/OptimisticPessimist/Teaching-Assistant-Python/blob/215756cf7dbb63a5c1a26fb32c7c9dd0be70c3c2/docs/function.md#L3 - 「下記の流れで関数を作っていくと進めやすい」のように、具体的な表記にした方が分かりやすいかと思います。 - https://github.com/OptimisticPessimist/Teaching-Assistant-Python/blob/215756cf7dbb63a5c1a26fb32c7c9dd0be70c3c2/docs/function.md#L23 - 戻り値と表記した方が良いかと思います。 - https://github.com/OptimisticPessimist/Teaching-Assistant-Python/blob/215756cf7dbb63a5c1a26fb32c7c9dd0be70c3c2/docs/function.md#L25-L29 1. 型ヒントの役割、型のあるコードは何故保守性が高くなるか、説明が必要だと思います。 2. 説明の順序が - 型ヒントのメリット - 関数のメリット - 関数の役割 の順に説明していますが、 - 関数の役割 - 関数のメリット - 型ヒントの役割・メリット の順に説明した方が分かりやすいと思います。 - コードブロックの言語指定は `python=` だと反映されないようです。 - 改行が反映されてない箇所があります。
Teaching-Assistant-Python/docs/function.md
Line 3 in 215756c
Teaching-Assistant-Python/docs/function.md
Line 23 in 215756c
Teaching-Assistant-Python/docs/function.md
Lines 25 to 29 in 215756c
型ヒントの役割、型のあるコードは何故保守性が高くなるか、説明が必要だと思います。
説明の順序が
の順に説明していますが、
の順に説明した方が分かりやすいと思います。
python=だと反映されないようです。