Repository navigation
docs: rewrite the em-dash sentences across docs, comments and generated text - #1712
Merged
Merged
Conversation
…ed text The style standard names the em dash as the mark that makes prose read as machine-written, and I would rather not carry it in public text at all than argue each one against the rate threshold. 1626 of them, across the nine Markdown files, the code comments, the workflows, the Debian packaging and the two generated surfaces. Every one is a sentence-level rewrite: a comma, a colon, a semicolon, parentheses or a split sentence, whichever the sentence actually wanted. A spaced hyphen left in place would be the same tell. Two deliberate exceptions, both recorded in the issue. bench/aggregate.py keeps its em-dash string for a table cell with no measurement, because there it is a data glyph rather than punctuation. And no line is added or removed anywhere: every rewrite substitutes inside the existing wrapping, so the diff reads one line for one line and the line-limit gate cannot move. Behaviour is unchanged. No test asserts on any of the reworded log or error strings, and the version-controlled SVG was regenerated in step with the generator that writes it. Signed-off-by: Jaro-c <75870284+Jaro-c@users.noreply.github.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
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.
Summary
Changes
docs/commands.mdcarried 48,docs/docker-migration.md26,docs/self-update.md23. ThreeREADME.mdheadings changed shape (### Optional: macOS), which moves their anchors; I grepped the tree and nothing links to them.internal/compose/types/service.rsalone had 98, all of one shape: a doc comment naming a backticked compose key, then a dash, then the description. A colon there would read as a doubled colon, since the compose key already ends in one, so those 98 took a verb instead (`image:` is the container image reference). The booleans do not take a verb, so there the dash became a comma.bench/chart.pywrites the SVG title, sodocs/assets/bench.svgchanged with it.about.hbsrenders the NOTICES attribution line.debian/changelog, 27, all in entries for 2.0.0 through 4.0.0.dpkg-parsechangelogstill reads the file.bench/aggregate.pyreturns an em-dash string for a table cell with no measurement. That is a data glyph rather than punctuation, and changing it would alter published benchmark output without removing any tell.git diff --numstatshows every file at equal insertions and deletions, soline-limitcannot move and the diff reads one line for one line.Test plan
cargo fmt --all --checkis cleancargo clippy --locked --all-targets --all-features -- -D warningsis cleancargo test --locked --all-features --workspacepasses locally (2385 tests, 0 failures)./tests/shell/*.test.shpass locally (every tracked test, includingci-runs-every-test.test.sh)*.shand every extensionless script with a shell shebanginternal/, the engine integration, or the libpod REST adapterinstall.sh,install.ps1,internal/update/install.rs, the signing scripts or the release fixturesThe last two run in this PR's own checks rather than locally;
internal/andinstall.share both touched, comments only in each. This PR adds and changes no check, so there is no control to delete and watch go red. What it does touch is the wording of existing log and error strings, and I grepped the suites for every reworded string first to confirm none is asserted on.Checklist
develop(the release pull request that targetsmainis the one exception, gated byreusable-main-guard.yml)git commit -s)required_signaturesis enforced ondevelopandmain)type:,prio:,effort:,area:where applicable)tests/shell/is named in some workflow'stest-command(no new file here)Cargo.tomlanddebian/changelogare at the same version (neither version line is touched)cargo build --release --locked --bin podupfitsbench/binary-budget-mibfor changes that can move the binary size (comments and docs cannot move it)Related issues
Refs #1711.