Skip to content

refactor: trim and simplify code comments#38

Merged
ivanbanov merged 2 commits into
mainfrom
better-code-comments
Jun 25, 2026
Merged

refactor: trim and simplify code comments#38
ivanbanov merged 2 commits into
mainfrom
better-code-comments

Conversation

@ivanbanov

Copy link
Copy Markdown
Contributor

Summary

  • Remove comments that restate what names and code already say (file-level architecture narrations, section dividers, "Drain until empty, FIFO" style notes)
  • Shorten multi-paragraph JSDoc blocks to one-line or short bullet summaries
  • Keep comments that document non-obvious decisions: StrictMode destroy() reason, after-timer generation counter, busDirty mid-pass skip logic, NoInfer on target/initial, focusableaccessible RN pair, live: 'off''none' transform

Files changed

Core engine (machine.ts, computed.ts, connector.ts, transitions.ts, actions.ts, guards.ts, setup.ts, types.ts, reaction.ts, compose.ts, store.ts) and renderer normalizers (react, native, opentui) + shared bindings.

Net: −730 comment lines, 0 logic changes.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dunky-state-machine Ready Ready Preview, Comment Jun 25, 2026 12:00pm

ivanbanov and others added 2 commits June 25, 2026 13:59
Remove comments that restate what the code already says, strip
multi-paragraph docblocks that read like prose documentation rather
than code commentary, and shorten over-explaining inline notes to
one-line summaries.

Kept: non-obvious constraints (StrictMode destroy() decision, after-timer
generation counter, busDirty mid-pass skip logic, NoInfer on target/initial,
focusable→accessible RN pair, live 'off'→'none' transform).

Co-authored-by: Claude <noreply@anthropic.com>
Also fix lint-staged oxlint "no files" exit code for ignored paths.

Co-authored-by: Claude <noreply@anthropic.com>
@ivanbanov ivanbanov force-pushed the better-code-comments branch from 04fd2b3 to c72b0cc Compare June 25, 2026 11:59
@ivanbanov ivanbanov merged commit c72b0cc into main Jun 25, 2026
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant