prometheus/client_python

Enhancement request: better documentation

Open

#528 aberto em 12 de mar. de 2020

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

Métricas do repositório

Stars
 (3.404 stars)
Métricas de merge de PR
 (Mesclagem média 10d 7h) (4 fundiu PRs em 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?

Guia do colaborador

Direção de pesquisa
Revise a estrutura de documentação existente, identifique a documentação da API ausente para classes como Registry e métodos como collect, e proponha melhorias. Siga o guia de estilo de documentação do projeto.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80