floatdrop / floatdrop/hdrhistogram_zig
Improve code documentation
オープン
help wanted
- 主要言語
- Zig
- スター
- 2
- フォーク
- 0
- PR マージ指標
- 30日以内にマージされた 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` と、言及されているビット操作を実行する内部関数を見つけます。bucket と subbucket がどのように構成されているかを確認し、その後、変数、操作、構造を ASCII ダイアグラムで文書化します。コードドキュメントからこれらの内部の仕組みを理解できるようになった時点で、作業は完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- zig
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100