Repository navigation
chore: comment drift cleanup - #131
Merged
Merged
Conversation
Repo-wide comment audit and trim, applying CLAUDE.md ("idiomatisch,
kurz und prägnant; keine Gedankenstriche") and the system-default
"default to no comments unless the WHY is non-obvious".
Drift fixes (stale claims, broken references):
- ^FP registry status flipped from 'unsupported' to 'supported' (the
command shipped weeks ago; the ZPL Output panel was lying).
- ^DF/^XF wording corrected (generator emits ^DF/^XF with R: drive
path, not ^DFR/^XFR as the comment claimed).
- ^LR comment rewritten to spec-correct persistent printer default
(was "label-wide" which suggested per-block scope).
- ^FC secondary/tertiary clock chars: comment now states the spec
gap honestly and links to a new follow-up ticket; the
implementation treats all three identically while spec distinguishes
them via ^SO offsets.
- ^ST scope clarified as battery-backed RTC, not EEPROM (grouped
with 'persistent' purely for emit order).
- PrintQualityTab caveat about ^JZ/^JT/~TA living in per-label path
removed (long since fixed; per-label generator emits none of them).
- "until settings UI lands", "for now multi-profile", broken
see-memory: refs, history narration, and "future X" speculation
dropped throughout.
Em-dash sweep: project rule "Kommentare dürfen keine Gedankenstriche
enthalten" enforced in code comments across src/lib, src/components,
src/store, src/types, src/registry, src/hooks plus tests. Initial
mechanical ' — ' → '; ' overshot for appositive and label-then-
detail patterns; iter-5 swept ~99 punctuation swaps to pick the
right one per case (', ', ': ', '.', '()' as appropriate).
zplCommandSupport.ts description strings (UI-visible labels) also
swept to colons for consistency.
Systematic idiomatic trimming:
- Drop framing words (Caveat:, Note:, Important:) without substance.
- Drop sentences that restate what the function name + signature say.
- Drop history narration ("originally lived in X", "we used to") that
belongs in commit messages.
- Drop speculative-future hedges ("future X will use this", "designed
to be reusable") that don't describe a present contract.
- Drop double-explanations: two ways of saying the same thing.
- Compress multi-paragraph blocks to one or two sentences.
Substance preserved verbatim where it carries non-obvious WHY:
- Spec citations and URLs
- Bug-anchored workarounds (browser quirks, firmware behaviour, race
conditions, ASCII-hex universality, Code93/Code11 quiet-zone delta)
- Cross-field invariants the code itself doesn't enforce
- DST-safe Julian day construction, Konva text rotation numeric drift,
Maxicode mode-spec summary, ZPL Alt Compression character table
Numbers: 162 files touched, +563/-2743 = ~2180 net comment-lines
deleted, JSDoc-line density down ~60% (2,351 → 889). 1,540 tests
green, lint/build clean.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request performs a comprehensive cleanup of comments across the entire codebase. It shortens verbose explanations, removes redundant comments, and standardizes punctuation (such as replacing em-dashes with semicolons or commas) to improve readability and maintainability without altering any functional code logic. As there are no review comments provided, I have no feedback to offer.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
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.
No description provided.