floatdrop/hdrhistogram_zig

Improve code documentation

Open

#1 aberto em 26 de out. de 2025

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Zig (0 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (2 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

It would be nice to add more documentation about internal variables (like sub_bucket_mask) and some ascii diagrams about structure of buckets/subbuckets. Also some bit operations in internal functions could have more clarifications.

Guia do colaborador

Direção de pesquisa
Leia o código fonte para entender variáveis internas como sub bucket mask e operações de bits, depois adicione comentários e diagramas ASCII para clareza.
Pilha de tecnologia
zig
Domain
backend
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Zig
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80