python / python/typing

Expand documentation for integrating type stubs into existing code bases

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

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

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

説明

On https://typing.readthedocs.io/en/latest/index.html there are various sections to help users find tools such as type checkers, linters and formatters, and development environments with type support.

I had previously asked in python/typeshed#8482 how would a user go about integrating existing type stubs into their application. This may be due to a third party or typeshed having created stubs either because the type hints were missing in a library or the provided type information was sufficiently inaccurate to encourage the user to take this type of action.

The team was kind enough to suggest various tools to assist with addressing this problem, and I was wondering if there was an appetite by the team here to incorporate a new "Type Stub Integration" section (or a different proposed name) to the Typing-Related Tools section?

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

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

はじめの一歩

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

調査の方向性

まず、https://typing.readthedocs.io/en/latest/index.html の Typing-Related Tools セクションと、python/typeshed#8482 で参照されている統合に関する議論を読みます。Type Stub Integration セクションに適した範囲と名称を決定し、その後、ユーザーが既存のスタブを統合するためのガイダンスと関連ツールを見つけられるようにドキュメントを更新します。

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

評価

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

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

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