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.