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