chore: reduce walls of comments#132
Merged
Merged
Conversation
gmelodie
force-pushed
the
chore/reduce-comments
branch
from
July 15, 2026 13:25
f5055b6 to
d7ef455
Compare
gmelodie
marked this pull request as ready for review
July 15, 2026 13:26
Ivansete-status
approved these changes
Jul 15, 2026
Ivansete-status
left a comment
Collaborator
There was a problem hiding this comment.
We need to confirm there are no weird acronyms being used.
Thanks!
gmelodie
force-pushed
the
chore/reduce-comments
branch
from
July 15, 2026 14:45
d7ef455 to
1b0e4f8
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
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.
Summary
The FFI layer had accumulated large comment walls — multi-paragraph module headers, multi-line
#rationale blocks, and long per-proc/field docstrings — that mostly restated what the code already says. This trims them to the project's comment budget: no multi-line non-doc comments (a single#line, or self-explanatory code), and docstrings capped at 3 lines (usually 1). Load-bearing WHY notes (malloc/free-vs-ORC-TLS thread hazards, single-fire callback, ABI wire-format seams, deadlock/reentry rationale) are kept — compressed to one line each rather than deleted.Net effect across 51 files: 575 insertions, 1816 deletions. The insertions are almost entirely multi-line blocks collapsed into single terse lines, so the actual comment-text reduction is well past the line ratio.
Affected Areas
ffi/runtime (thread, event, request-queue, context, cbor, alloc),ffi/internal/macros (ffi_macro,c_macro_helpers,ffi_library,ffi_scalar),ffi/codegen/generators (rust, cpp, c, meta, cddl, types_ir, string_helpers), the unit/bench tests, and the echo/timer examples. Changes are limited to comments and docstrings — no code tokens, identifiers, or emitted-code string literals were touched.Impact on Library Users
No impact — comment-only change. No API, behavior, or performance change.
Risk Assessment
Minimal. Every touched file passes
nph --checkunchanged. Diff inspection confirms each changed code line differs only by a removed/shortened trailing comment; the code is byte-identical. No functional lines were altered.References
N/A