python / python/typeshed

Stubtest docs: common failure/suppression examples + debugging guidance

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

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

project: infrastructure
主要言語
Python
スター
5.1k
フォーク
2.1k
平均マージ
1日 19時間
マージ済み PR(30日)
82

説明

I feel like the contributing guide could benefit from instructions around debugging stubtest failures, and examples of things that stubtest can't handle that would warrant suppressions.

The mypy stubtest docs don't really go into enough detail or have enough examples, which makes it harder for new contributors (like myself) to debug failures.

Maybe we could improve that doc and link to it from CONTRIBUTING.md. I think that would reduce the need for maintainers to help stub contributors debug these failures, and make things a bit more self-service.

I'm happy to contribute to this, though I'm a bit too new to know which specific patterns are commonly suppressed.

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

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

はじめの一歩

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

調査の方向性

CONTRIBUTING.md とリンク先の mypy stubtest ドキュメントから始め、stubtest のデバッグと抑制に関するガイダンスをどこに置くべきかを特定します。一般的な失敗例と抑制例を追加し、失敗をデバッグする方法を説明し、改善したドキュメントへのリンクを CONTRIBUTING.md から追加すれば完了です。

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

評価

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

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

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