style: cleanup comments - #120
Merged
Merged
Conversation
amkram
changed the title
Comment/docstring-only cleanup, same rubric as the earlier deslop pass but covering the code merged since (index param header, mmap uncompressed index, parallel FASTQ reader, scoring prefetch, ZSTD framing) and applied more aggressively: - delete perf-narrative / commit-message flavor from the source (malloc %, ms-overhead, L3-latency, load-factor, "hot path") -- it lives in git history; - delete comments that don't earn their place (restating obvious code, struct/section labels, decorative dividers, trailers echoing the field name); - compress every remaining >2-line comment toward the essential one or two lines; - keep every non-obvious why, invariant, unit, math derivation, citation, TODO. No behavior change. Verified comments-only vs main (comment+whitespace-stripped code byte-identical across all 22 files); build clean, 0 warnings; unit + e2e + examples pass. Excludes mgsr.* and samtools-derived pileup.c/h. 22 files, -223 lines net.
amkram
force-pushed
the
chore/deslop-comments-2
branch
from
July 14, 2026 03:12
291dfd2 to
2708499
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.