Repository navigation
Remove comments that restate the code - #27
Merged
laurenspriem merged 1 commit intoNov 3, 2026
Merged
Conversation
Keep only comments carrying information the code cannot express: unsafe soundness arguments, overflow and saturation reasoning, deliberate libheif and libde265 parity choices and divergences, and the reasons behind loud rejections of unsupported stream features.
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
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.
Removes every comment the code already expresses across the decoder, the test scripts and the CI workflow, including rustdoc on public items. What stays is only what the code can't say:
SAFETYarguments, overflow and saturation reasoning, deliberate libheif/libde265 parity choices and known divergences, and why unsupported stream features are rejected outright.Behavior is unchanged. The only code edit is collapsing
else { if … }toelse ifindecode_part_mode, which clippy requires once the comment between them is gone.Public items no longer carry rustdoc.
API.mdstill documents most of the API, but the RGB8 entry points (DecodedRgbImage,decode_bytes_to_rgb8,decode_path_to_rgb8) are now undocumented outside the code.Source fork PR: laurens-pilot#15
@laurenspriem