prometheus/client_python

Enhancement request: better documentation

開放

#528 建立於 2020年3月12日

在 GitHub 查看貢獻者指南
 (3 則留言) (20 個反應) (0 位負責人)Python (732 個分叉)batch import
help wanted

倉庫指標

星標
 (3,404 顆星)
PR 合併指標
 (平均合併 10天 7小時) (30 天內合併 4 個 PR)

描述

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?

貢獻者指南

研究方向
審查現有文檔結構，找出缺少的API文檔（如Registry類和collect方法），並提出改進建議。遵循專案的文檔風格指南。
技術棧
python
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonGit
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80