Add a document detailing how the encoder implementation works. #133
Conversation
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
skef
reviewed
Jun 24, 2025
This is meant to primarily document how the current implementation functions and not intended to describe how encoders should work in general.
garretrieger
force-pushed
the
encoder_doc
branch
from
34d3256 to
b63a7c1
Compare
|
The part of the doc I haven't reviewed is the algorithm description, but if there are concerns there they can always be addressed later. So let's consider the comments above to be the extent of my review. |
Sounds good, thanks for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is meant to primarily document how the current implementation functions and not intended to describe how encoders should work in general.