prometheus/client_python

Enhancement request: better documentation

Open

#528 opened on Mar 12, 2020

View on GitHub
 (3 comments) (20 reactions) (0 assignees)Python (3,404 stars) (732 forks)batch import
help wanted

Description

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?

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic PythonFamiliarity with Prometheus client library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.