chore: normalize prose + comments to devflow style (no em-dash/arrow/ellipsis)#43
Merged
Conversation
…ellipsis)
Repo-wide sweep converting the three unicode punctuation marks that
diverge from the devflow style guide:
em-dash -> ' - ' (spaced hyphen)
unicode arrow -> '->'
ellipsis -> '...'
Scope guardrails (docs + comments only, never behavior):
* Markdown: prose converted; fenced code blocks preserved verbatim
(literal examples, and cheatsheet.md is embedded in `solx cheatsheet`).
* Rust / YAML / shell: only full-line comments converted; string
literals, CLI output, echo/printf, and JSON data left untouched.
* Three soft-wrapped em-dash continuations that would have rendered as
stray Markdown bullets were rewrapped inline.
No code behavior change: `cargo test` (104 unit + 40 integration), clippy,
and fmt all still pass. Docs/comments only, so no version bump.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Shu-Wan
force-pushed
the
chore/devflow-style-sweep
branch
from
July 17, 2026 00:16
9741640 to
8c218ee
Compare
Shu-Wan
added a commit
that referenced
this pull request
Jul 17, 2026
…rule (#44) Follow-up to #43 (docs + code comments). Converts the remaining em-dash / ellipsis marks in the CLI's own output strings and their test assertions, so the CLI speaks devflow style too: side.rs, jobs.rs, keep.rs, the config.rs starter config, and the matching cli.rs stderr assertions. The unicode round-trip test fixture in output.rs (json!("café — ok...")) is left as-is - the em-dash there is the test subject. Also documents in DEVELOPMENT.md that a CLI-only release (skill guidance unchanged) does not need the skill evals re-run - the crate test suite plus an L3 CLI smoke is the gate. Cosmetic output only, so no version bump. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Shu-Wan
added a commit
that referenced
this pull request
Jul 17, 2026
Completes the devflow mark sweep (#43, #44). #43 preserved fenced code blocks verbatim; this converts the em-dash / arrow / ellipsis marks in their `#` comment/annotation portions only - never command text (every changed line is a shell comment). 41 marks across 9 docs. `references/cheatsheet.md` is embedded in `solx cheatsheet`, so its output now shows `->` in those annotations. The committed `docs/cheatsheet.pdf` is unaffected: only arrows changed there, and `build-cheatsheet.sh` already rewrites the arrow to `->` for the PDF. Docs only, no version bump. `cargo test` 104+40 green (incl. the cheatsheet needle test). Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Repo-wide sweep bringing prose and comments in line with the devflow style guide, converting the three unicode punctuation marks the repo used that the guide forbids:
—(em-dash)-(spaced hyphen)→(unicode arrow)->…(ellipsis)...No code behavior change — 44 files, 472 insertions / 472 deletions (line-for-line punctuation only).
Scope guardrails (docs + comments only, never behavior)
The sweep was deliberately conservative so it can't change what the CLI does or break a test:
references/cheatsheet.mdis embedded intosolx cheatsheet, so touching code-block interiors would change CLI output."dry-run — would run:",NOT_SOL_MESSAGE, …),echo/printf/sedoutput, andevals/*.jsondata are left untouched (verified: every non-comment mark is a string/output/value).—landing at column 0) were rewrapped inline.Verification
cargo test: 104 unit + 40 integration pass ·cargo clippy -D warningsclean ·cargo fmt --checkclean.Deliberately left (out of this sweep's declared scope)
# the fast queue — good,low → prefer) — ~40 occurrences, preserved because they're literal examples andcheatsheet.mdfeedssolx cheatsheet. Happy to convert these in a follow-up if you want them normalized too (it would changesolx cheatsheetoutput).−(U+2212 minus) inGres − GresUsed— a math minus, outside the three-mark scope.🤖 Generated with Claude Code