python / python/mypy

Better documentation for the HTML report

オープン
#13,495 コメント 2 件 リアクション 4 件 担当者 0 名 GitHub で見る

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

documentation
主要言語
Python
スター
20.6k
フォーク
3.3k
PR マージ指標
PR 指標を取得中

説明

Documentation

This is the only thing I can find in the docs about this HTML report, and it's far from complete. I could find these three questions on Stack Overflow, but none of them have satisfying answers (or answers at all).

I understand that mypy is reporting the presence of expressions of type Any in each line. (Is it? Did I get that right?) But what exactly do the colors mean? Why do lines with @overload always get colored red in my reports? Why do lines with isinstance always get colored yellow?

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

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

はじめの一歩

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

調査の方向性

まず、issue にリンクされているコマンドライン HTML レポートのドキュメントから始め、次にリンクされている3つの Stack Overflow の質問を使って不足している説明を特定します。レポートが何を測定するのか、その色が何を意味するのか、また @overload や isinstance などの構文がなぜ観測された色になるのかを文書化します。ユーザーが未回答の外部の質問に頼らずにレポートを解釈できれば完了です。

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

評価

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

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

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