python / python/typing

Should we add links to existing resources?

オープン
#1,046 コメント 7 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

topic: documentation
主要言語
Python
スター
1.8k
フォーク
302
平均マージ
23時間
マージ済み PR(30日)
8

説明

I was catching up on a long python-dev discussion about the state of type annotations, and noticed that @gvanrossum had asked for a list of easily discoverable (by search engines) resources regarding typing.

I collected up this note:
https://gist.github.com/stroxler/ade7977ed07e27448222a468796bc467

Would we want to include a couple of the best links (in particular the RealPython blog, maybe the LogRocket one as well) in our docs? At least at this time, those may actually be the two best getting-started tutorials. The mypy docs are much more thorough and incredibly useful as a reference, but aren't really written in a manner where a beginner could easily skim them end-to-end.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、リンク先の gist と既存の型付けに関するドキュメントを読み、次に Real Python と LogRocket の提案されているチュートリアルを mypy のリファレンス資料と比較します。初心者に適したリソースを確認し、外部の入門リンクを掲載すべきドキュメントページを特定します。選定したリンクを明確な説明付きで追加するか、追加すべきでない理由を issue に記録すれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。