Add docs for BitReader#9948
Merged
Merged
Conversation
Merged
alamb
added a commit
that referenced
this pull request
May 14, 2026
# Which issue does this PR close? - Related to #9372 # Rationale for this change Similarly to #9948. I ran into BitWriter as part of reviewing code from @sdf-jkl and wanted to document my findings (so I didn't have to re-read the code each time) - #9372 # What changes are included in this PR? Add docs # Are these changes tested? By CI # Are there any user-facing changes? No -- this is docs to an internal structure
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
2 participants
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.
Which issue does this PR close?
Rationale for this change
While reviewing the ALP implementation from @sdf-jkl , I ran into this struct which I haven't really used before.
Now that I have read it, I wanted to capture that information as doc comments (for my future self and hopefully for others)
What changes are included in this PR?
Add documentation comments to
BitReaderAre these changes tested?
Just docs,
Are there any user-facing changes?
Just docs on an internal struct,