prometheus/client_python

Enhancement request: better documentation

Open

#528 opened on 2020年3月12日

GitHub で見る
 (3 comments) (20 reactions) (0 assignees)Python (732 forks)batch import
help wanted

Repository metrics

Stars
 (3,404 stars)
PR merge metrics
 (平均マージ 10d 7h) (30d で 4 merged PRs)

説明

The documentation for this library is incomplete. It could really use some thorough API documentation. For example, what is a Registry? When does the collect method get called, and what is its contract?

コントリビューターガイド

調査方針
既存のドキュメント構造を確認し、RegistryクラスやcollectメソッドなどのAPIドキュメントが不足している箇所を特定し、改善提案を行ってください。プロジェクトのドキュメントスタイルガイドに従ってください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonGit
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80