docs: remove em dashes from code and docs #2

Merged
Breadway merged 3 commits from fix/em-dash-cleanup into main 2026-09-09 13:59:46 +08:00
Owner

Part of bread-ecosystem-wide cleanup (breadboard issue ROAD-1) to remove em dashes and other "AI writing tell" characters from the codebase.

Replaced every em dash (U+2014) in comments, doc comments, and markdown docs with whatever plain ASCII punctuation reads best in context: comma, colon, semicolon, or a light rewrite. No blind find/replace; each occurrence was read in context.

Files touched: .forgejo/workflows/{dev-release,rc-release,release}.yml, AGENTS.md, CONTRIBUTING.md, EVENTS.md, README.md, ci/build.sh, src/bread_events.rs, src/mirror.rs, src/monitor.rs, src/profile.rs, src/store.rs, src/ui/mod.rs.

One em dash was intentionally preserved and left untouched:

  • src/ui/config_view.rs:432 — format!(" {} — {}{}", m.name, m.description, ppi_hint). This is a rendered TUI header string, not prose; it's a visual separator consistent with the box-drawing │ glyph used a few lines earlier in the same view's PPI hint. Treated as UI presentation data rather than an AI writing tell.

No functional changes; diff review only, no full build/test run.

Part of bread-ecosystem-wide cleanup (breadboard issue ROAD-1) to remove em dashes and other "AI writing tell" characters from the codebase. Replaced every em dash (U+2014) in comments, doc comments, and markdown docs with whatever plain ASCII punctuation reads best in context: comma, colon, semicolon, or a light rewrite. No blind find/replace; each occurrence was read in context. Files touched: `.forgejo/workflows/{dev-release,rc-release,release}.yml`, `AGENTS.md`, `CONTRIBUTING.md`, `EVENTS.md`, `README.md`, `ci/build.sh`, `src/bread_events.rs`, `src/mirror.rs`, `src/monitor.rs`, `src/profile.rs`, `src/store.rs`, `src/ui/mod.rs`. One em dash was intentionally preserved and left untouched: - `src/ui/config_view.rs:432` — `format!(" {} — {}{}", m.name, m.description, ppi_hint)`. This is a rendered TUI header string, not prose; it's a visual separator consistent with the box-drawing `│` glyph used a few lines earlier in the same view's PPI hint. Treated as UI presentation data rather than an AI writing tell. No functional changes; diff review only, no full build/test run.
Replace em dashes across comments, doc strings, and markdown docs with
plain ASCII punctuation (commas, colons, semicolons, or a light rewrite)
chosen per context. One UI display separator in src/ui/config_view.rs
is intentionally preserved for consistency with the box-drawing glyphs
already used in that view.
Author
Owner

Reviewed. The em-dash cleanup on fix/em-dash-cleanup (PR #2) is substantively fine: punctuation-only edits in comments, doc strings, and Markdown, no logic changes, no new em dashes on added lines, clean commit message.

Blocker: the branch no longer merges cleanly into main. Content conflict in AGENTS.md. Rebase onto origin/main (or merge main in), resolve the AGENTS.md conflict keeping both the upstream change and the em-dash removals, and push to the same branch. PR #2 stays open, no new PR.

Secondary, please address in the same push: src/ui/config_view.rs:432 still joins m.name and m.description with an em dash in the rendered TUI header string. The commit message calls this an intentional separator, but sibling repos in this same pass reworded equivalent now-playing / status display strings to a comma or colon. Match that convention here for consistency (a colon reads fine: format!(" {}: {}{}", ...)).

CI has never run for this branch; confirm check is green after the rebase.

Leaving this in review.

Reviewed. The em-dash cleanup on `fix/em-dash-cleanup` (PR #2) is substantively fine: punctuation-only edits in comments, doc strings, and Markdown, no logic changes, no new em dashes on added lines, clean commit message. Blocker: the branch no longer merges cleanly into `main`. Content conflict in `AGENTS.md`. Rebase onto `origin/main` (or merge main in), resolve the `AGENTS.md` conflict keeping both the upstream change and the em-dash removals, and push to the same branch. PR #2 stays open, no new PR. Secondary, please address in the same push: `src/ui/config_view.rs:432` still joins `m.name` and `m.description` with an em dash in the rendered TUI header string. The commit message calls this an intentional separator, but sibling repos in this same pass reworded equivalent now-playing / status display strings to a comma or colon. Match that convention here for consistency (a colon reads fine: `format!(" {}: {}{}", ...)`). CI has never run for this branch; confirm `check` is green after the rebase. Leaving this in review.
Resolves the AGENTS.md conflict, keeping main's runner-hostname scrub
and the branch's punctuation fixes.
style: use a colon in the monitor header instead of an em dash
All checks were successful
check / check (push) Successful in 35s
5e2e146594
Matches the equivalent display-string rewordings in sibling repos from
the same ROAD-1 cleanup pass.
Author
Owner

Merged current main into fix/em-dash-cleanup (merge commit 468f603) plus a follow-up (5e2e146), pushed to origin, PR #2 still open.

AGENTS.md had two conflict regions, both resolved keeping both sides: main's runner-hostname scrub ("via Hestia" and the "(hestia)" runner note dropped) plus the branch's em-dash punctuation fixes. Merge otherwise only pulled main-side CI workflow YAML edits.

config_view.rs line 432: the monitor header format string now joins m.name and m.description with a colon instead of the em-dash separator, per the review note and matching the sibling-repo convention. No test asserts that string.

Verified locally on the merged branch: cargo build --locked, cargo clippy --all-targets --locked -- -D warnings, and cargo test --locked (27 tests) all clean. Repo-wide rescan: no em dashes remain in tracked files.

Merged current `main` into `fix/em-dash-cleanup` (merge commit 468f603) plus a follow-up (5e2e146), pushed to origin, PR #2 still open. AGENTS.md had two conflict regions, both resolved keeping both sides: main's runner-hostname scrub ("via Hestia" and the "(hestia)" runner note dropped) plus the branch's em-dash punctuation fixes. Merge otherwise only pulled main-side CI workflow YAML edits. config_view.rs line 432: the monitor header format string now joins `m.name` and `m.description` with a colon instead of the em-dash separator, per the review note and matching the sibling-repo convention. No test asserts that string. Verified locally on the merged branch: `cargo build --locked`, `cargo clippy --all-targets --locked -- -D warnings`, and `cargo test --locked` (27 tests) all clean. Repo-wide rescan: no em dashes remain in tracked files.
Breadway deleted branch fix/em-dash-cleanup 2026-09-09 13:59:46 +08:00
Author
Owner

Reviewed and merged (squash, PR #2, branch deleted). Em-dash cleanup across comments, doc strings, and markdown. The one TUI header separator at src/ui/config_view.rs:432 (originally flagged as an intentional keep) was instead reworded to a colon, which is consistent with the sibling-repo display-string rewordings and leaves the repo fully em-dash free. Verified zero em dashes remain. CI green (check: 35s), no conflicts.

Reviewed and merged (squash, PR #2, branch deleted). Em-dash cleanup across comments, doc strings, and markdown. The one TUI header separator at src/ui/config_view.rs:432 (originally flagged as an intentional keep) was instead reworded to a colon, which is consistent with the sibling-repo display-string rewordings and leaves the repo fully em-dash free. Verified zero em dashes remain. CI green (check: 35s), no conflicts.
Sign in to join this conversation.
No reviewers
No labels
ci
No milestone
No project
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/breadmon!2
No description provided.