refactor: cut inline comments in favor of tests#91
Merged
Conversation
Reduce inline comments ~78% (286 -> 62) across src, templates, example, and tutorials. Behavior is documented by tests and user-facing JSDoc instead of narration that drifts as code changes. Kept: functional directives (deno-lint-ignore, @ts-expect-error) and a few one-line load-bearing notes (framework/runtime gotchas). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
🎉 This PR is included in version 0.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
1 participant
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
Reduce inline code comments by ~78% (286 → 62) across
src,templates,example, andtutorials. Inline comments drift silently as code changes;behavior is documented by tests (named for the rule they pin) and user-facing
JSDoc instead.
Changes
scaffolding templates, the demo app, and tutorials
of one-line load-bearing notes (framework/runtime gotchas)
Testing
deno task checkclean;deno task test→ 19 passed, 0 failed. Diff verifiedcomment-only — no behavioral code changes.