floatdrop / floatdrop/hdrhistogram_zig

Improve code documentation

Offen
#1 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
help wanted
Vorherrschende Sprache
Zig
Sterne
2
Forks
0
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne damit, `sub_bucket_mask` und die internen Funktionen zu finden, die die erwähnten Bitoperationen ausführen. Überprüfe, wie Buckets und Subbuckets strukturiert sind, und dokumentiere anschließend die Variablen, Operationen und die Struktur mit ASCII-Diagrammen; die Arbeit ist abgeschlossen, wenn diese Interna anhand der Codedokumentation verständlich sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
zig
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.