floatdrop/hdrhistogram_zig

Improve code documentation

Open

#1 建立於 2025年10月26日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Zig (0 fork)github user discovery
help wanted

倉庫指標

Star
 (2 star)
PR 合併指標
 (PR 指標待抓取)

描述

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.

貢獻者指南

研究方向
閱讀原始碼，了解內部變數（如 sub bucket mask）和位操作，然後添加註釋和 ASCII 圖以增加清晰度。
技術棧
zig
領域
backend
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Zig
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80