prometheus/client_python

Enhancement request: better documentation

Open

#528 建立於 2020年3月12日

在 GitHub 查看
 (3 留言) (20 反應) (0 負責人)Python (3,404 star) (732 fork)batch import
help wanted

描述

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?

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic PythonFamiliarity with Prometheus client library
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
The issue asks for better API documentation, specifically explaining what a Registry is and the contract of the collect method. Look at the source code files like registry.py and collector.py in the repository to understand the current implementation. Check existing documentation (e.g., README, docs folder) to identify gaps. Add docstrings to the relevant classes and methods, and possibly update the README or create a dedicated documentation page. The issue has been open since 2020 with some comments, but no one has worked on it yet, making it a good candidate for a first contribution.