Breadway/bread
1
0
Fork 0
Code Issues 9 Pull requests 2 Projects Releases Packages Wiki Activity Actions

Remove em dashes from code and docs #4

Merged
Breadway merged 1 commit from fix/em-dash-cleanup into main 2026-09-09 14:12:44 +08:00
Conversation 2 Commits 1 Files changed 63 +719 -719
Breadway commented 2026-09-06 20:42:59 +08:00
Owner
Copy link

Removes em dashes across the repo (comments, doc comments, Markdown docs, CI workflow comments, TOML comments), replacing each with whatever reads most naturally in context: colon, semicolon, comma, or parentheses.

Preserved as intentional (not prose "tells", but literal UI/display placeholder glyphs for "no value"):

  • examples/modules/active-window-widget.lua
  • examples/modules/cpu-temp-widget/init.lua
  • Examples.md (documents the same cpu-temp-widget snippet)

Documentation.md's IPC method tables also had their empty "Params" column changed from — to none for the same reason.

Removes em dashes across the repo (comments, doc comments, Markdown docs, CI workflow comments, TOML comments), replacing each with whatever reads most naturally in context: colon, semicolon, comma, or parentheses. Preserved as intentional (not prose "tells", but literal UI/display placeholder glyphs for "no value"): - `examples/modules/active-window-widget.lua` - `examples/modules/cpu-temp-widget/init.lua` - `Examples.md` (documents the same cpu-temp-widget snippet) `Documentation.md`'s IPC method tables also had their empty "Params" column changed from `—` to `none` for the same reason.
Breadway commented 2026-09-09 12:36:18 +08:00
Author
Owner
Copy link

Reviewed. Held for you to land: bread is on the release train, so this is a recommendation only, not a merge.

Acceptance criteria (my read): remove em dashes from comments, doc comments, Markdown, CI/TOML comments, replacing each with natural punctuation; preserve literal no-value placeholder glyphs used as UI display data; no functional changes.

Assessment:

  • All edits are punctuation-only in comments and string literals (error text, generated shell-hook comments, IPC method tables). No logic changes. Diff is line-for-line balanced (719/719).
  • The preserved placeholder glyphs in examples/modules/active-window-widget.lua, examples/modules/cpu-temp-widget/init.lua, and Examples.md, and the Documentation.md Params column changed to none, all match the stated exceptions and are correct.
  • No new em dashes on added lines. Commit message is clean (no attribution, no em dash).
  • Branch merges cleanly into main.

Nits, none blocking:

  1. The generated graphify-out/ tree (GRAPH_REPORT.md, graph.html, .graphify_labels.json) still contains em dashes, including in graph.html's own JS comments. These are generated artifacts and out of scope for a prose pass, but if you want the repo fully clean, regenerate with graphify update . after this lands.
  2. No CI run exists for the head commit, so I could not confirm a green build. Worth triggering check before you merge.

Recommendation: fine to merge once you are happy with the graphify-out question and CI is green. Leaving in review.

Reviewed. Held for you to land: `bread` is on the release train, so this is a recommendation only, not a merge. Acceptance criteria (my read): remove em dashes from comments, doc comments, Markdown, CI/TOML comments, replacing each with natural punctuation; preserve literal no-value placeholder glyphs used as UI display data; no functional changes. Assessment: - All edits are punctuation-only in comments and string literals (error text, generated shell-hook comments, IPC method tables). No logic changes. Diff is line-for-line balanced (719/719). - The preserved placeholder glyphs in `examples/modules/active-window-widget.lua`, `examples/modules/cpu-temp-widget/init.lua`, and `Examples.md`, and the `Documentation.md` Params column changed to `none`, all match the stated exceptions and are correct. - No new em dashes on added lines. Commit message is clean (no attribution, no em dash). - Branch merges cleanly into `main`. Nits, none blocking: 1. The generated `graphify-out/` tree (GRAPH_REPORT.md, graph.html, .graphify_labels.json) still contains em dashes, including in graph.html's own JS comments. These are generated artifacts and out of scope for a prose pass, but if you want the repo fully clean, regenerate with `graphify update .` after this lands. 2. No CI run exists for the head commit, so I could not confirm a green build. Worth triggering `check` before you merge. Recommendation: fine to merge once you are happy with the graphify-out question and CI is green. Leaving in review.
Breadway commented 2026-09-09 14:01:27 +08:00
Author
Owner
Copy link

Reviewed PR #4. Looks ready to merge, holding for you because bread is on the release train.

What it does: replaces em dashes across daemon and shared-crate comments, doc comments, Markdown, CI and TOML comments with plain punctuation. Balanced in-place edits (719/719), no functional changes. The Documentation.md IPC "Params" columns went from the placeholder glyph to "none".

Correctly preserved: the literal no-value display glyphs in examples/modules/active-window-widget.lua, examples/modules/cpu-temp-widget/init.lua, and the matching snippet in Examples.md.

Nits (do not block, your call):

  • The committed generated graph under graphify-out/ still contains em dashes: GRAPH_REPORT.md, 2026-08-16/GRAPH_REPORT.md, .graphify_labels.json, and graph.html (JS comments). Most come from node labels derived from AGENTS.md / CLAUDE.md headings, so a graphify update . regen after this lands should clear the label-derived ones; graph.html's own comments would need the template touched.
  • No CI status has been reported on the head commit (4c359d0). Worth a branch re-push to get a green run before you merge.

Leaving in review for you to land.

Reviewed PR #4. Looks ready to merge, holding for you because bread is on the release train. What it does: replaces em dashes across daemon and shared-crate comments, doc comments, Markdown, CI and TOML comments with plain punctuation. Balanced in-place edits (719/719), no functional changes. The `Documentation.md` IPC "Params" columns went from the placeholder glyph to "none". Correctly preserved: the literal no-value display glyphs in `examples/modules/active-window-widget.lua`, `examples/modules/cpu-temp-widget/init.lua`, and the matching snippet in `Examples.md`. Nits (do not block, your call): - The committed generated graph under `graphify-out/` still contains em dashes: `GRAPH_REPORT.md`, `2026-08-16/GRAPH_REPORT.md`, `.graphify_labels.json`, and `graph.html` (JS comments). Most come from node labels derived from `AGENTS.md` / `CLAUDE.md` headings, so a `graphify update .` regen after this lands should clear the label-derived ones; `graph.html`'s own comments would need the template touched. - No CI status has been reported on the head commit (`4c359d0`). Worth a branch re-push to get a green run before you merge. Leaving in review for you to land.
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
breadbug

   
bug

   
phase-1

   
phase-2

   
privacy
No labels
breadbug
bug
phase-1
phase-2
privacy
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Breadway/bread!4
No description provided.