prometheus/client_python

Enhancement request: better documentation

Open

#528 opened on Mar 12, 2020

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

Repository metrics

Stars
 (3,404 stars)
PR merge metrics
 (Avg merge 10d 7h) (4 merged PRs in 30d)

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

Research direction
Review the existing documentation structure, identify missing API docs for classes like Registry and methods like collect, and propose improvements. Follow the project's documentation style 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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80