Skip to content

docs(compress): comment cleanup for lz4 (#2026)#3579

Merged
oferchen merged 1 commit into
masterfrom
docs/comment-cleanup-lz4
May 4, 2026
Merged

docs(compress): comment cleanup for lz4 (#2026)#3579
oferchen merged 1 commit into
masterfrom
docs/comment-cleanup-lz4

Conversation

@oferchen
Copy link
Copy Markdown
Owner

@oferchen oferchen commented May 3, 2026

Summary

  • Trim restating-the-code comments and section banners across crates/compress/src/lz4/frame.rs and crates/compress/src/lz4/raw.rs to comply with the repo comment policy.
  • Preserve every informative comment (LZ4 frame layout, LCG rationale, header advertised vs supplied bytes, etc.) and every upstream rsync reference.
  • Convert ad-hoc upstream pointers into the canonical // upstream: token.c ... form so they are picked up by greps for upstream-anchored notes.
  • No code logic changes; comments only.

Fixes #2026

Test plan

  • CI: fmt+clippy
  • CI: nextest (stable)
  • CI: Windows / macOS / Linux musl

Trim restating-the-code comments and section banners across the lz4
frame and raw modules, while preserving informative context and
upstream rsync references. Convert ad-hoc references to upstream
token.c into the canonical `// upstream:` form.

Fixes #2026
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 3, 2026
@oferchen oferchen merged commit e1b1334 into master May 4, 2026
38 checks passed
@oferchen oferchen deleted the docs/comment-cleanup-lz4 branch May 5, 2026 04:19
oferchen added a commit that referenced this pull request May 5, 2026
Trim restating-the-code comments and section banners across the lz4
frame and raw modules, while preserving informative context and
upstream rsync references. Convert ad-hoc references to upstream
token.c into the canonical `// upstream:` form.

Fixes #2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant