Rewrite comments to read naturally, remove AI-style em dashes#1473
Merged
Conversation
Sweep code comments across the libraries, tests and docs site to strip the
em-dash-heavy, AI-generated phrasing that had crept in. Em dashes are rewritten
to ordinary punctuation (periods, commas, colons, parentheses, or joining
words), definitional dash-fragments ("Singleton -- only one X") become plain
sentences, ALL-CAPS mid-sentence emphasis is lowercased, and filler like
"just", "simply" and "Note that" is dropped.
Scope:
- Library, enterprise and binding source (dockview-core, dockview-enterprise,
dockview-vue, dockview-angular, dockview): comment text only.
- Test suites: comments, plus describe/test names switched from em dash to
colon for consistency.
- Docs site: code comments in sandboxes, templates and components, plus a
light touch on user-facing prose (READMEs, landing pages, release blurbs).
No runtime code changed; the only non-comment edits are string labels and
test/description text. The em dash rendered as an empty-value placeholder in
the debug-panel demo is left as-is.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UZrBEk48dxvwBR6VkskSxw
|
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.
Description
A copy-edit pass over comments across the codebase and docs site to remove the em-dash-heavy, AI-generated phrasing that had crept in, so comments read like a person wrote them.
What changed:
—) rewritten to ordinary punctuation (periods, commas, colons, parentheses, or joining words). This was the dominant tell (~500 occurrences).Singleton — only one X.,Passive — does not consume.) rewritten as plain sentences.AND,NOT,MUST) lowercased.just/simply/merely,Note that,NOTE:prefixes.Scope by area:
describe/testnames switched from—to:for consistency (no snapshot files exist, so names aren't coupled to anything).packages/docs/AGENTS.mdwriting-style guide already mandates this ("do not use em dashes… drop filler and marketing words"), so this brings existing content in line with it.214 files changed. No runtime code was modified: the only non-comment edits are string labels and test/description text. The
—glyph the debug-panel demo renders as an empty-value placeholder is intentionally left as-is.Type of change
Affected packages
dockview-coredockview(vanilla JS)dockview-reactdockview-vuedockview-angulardocsAlso touches
dockview-enterprise(not listed in the template).How to test
This is a comments-and-strings-only change; a review of the diff is the main check. Verification performed in place of a full test run (dependencies were not installed in the working environment):
/* */) delimiters are balanced and unchanged vs. the base in all 214 files, so no comment was left unterminated.describenames and four docs strings), which were reviewed line by line.Checklist
yarn lint:fixpassesyarn formatpassesnpm run genhas been run and generated files are up to dateyarn testpasses🤖 Generated with Claude Code
https://claude.ai/code/session_01UZrBEk48dxvwBR6VkskSxw
Generated by Claude Code