floatdrop/hdrhistogram_zig

Improve code documentation

Open

#1 opened on Oct 26, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Zig (0 forks)github user discovery
help wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Read the source code to understand internal variables like sub bucket mask and bit operations, then add comments and ascii diagrams for clarity.
Tech stack
zig
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Zig
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80