Skip to content

Use em-dash/en-dash instead of ASCII hyphen substitutes#1159

Open
mcfnord wants to merge 1 commit into
jamulussoftware:next-releasefrom
mcfnord:typography-em-en-dashes
Open

Use em-dash/en-dash instead of ASCII hyphen substitutes#1159
mcfnord wants to merge 1 commit into
jamulussoftware:next-releasefrom
mcfnord:typography-em-en-dashes

Conversation

@mcfnord

@mcfnord mcfnord commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Short description of changes

Converts hyphen-as-dash usage to the typographically correct character across the English docs:

  • Em-dash (—) for parenthetical asides, appositives, and heading breaks (e.g. Software-Manual.md: "Even if that person leaves and rejoins - or you join a server..." → "...rejoins — or you join a server..."), including existing -- double-hyphen stand-ins in Release-Process.md and Tips-Tricks-More.md.
  • En-dash (–) for numeric ranges (0-160–16, 30-50 ms30–50 ms, etc.) and for the "Title – Subtitle" pattern already established by Command-Line-Options.md, Privacy-Statement.md, and 2020-03-28-Server-Rpi.md404.html's title used a plain hyphen for the identical pattern; this makes it consistent with the other three.

Compound words, CLI flags, list-bullet hyphens, ISO dates, and anything inside code spans are untouched — those hyphens are already correct and this PR does not touch them.

19 files changed, 40 lines (one dash-class swap each).

Context

Follows the em-dash discussion on #1156, where the open question was really "what does correct typography require," separate from whether an individual line's style is a matter of taste. This applies that consistently rather than adding an isolated case.

Does this need translation?

YES (existing English strings changed at the character level) — targets next-release.

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I'm sure that this Pull Request goes to the correct branch

…utes

Converts hyphen-as-dash usages to the typographically correct character:
em-dash (—) for parenthetical asides, appositives, and heading breaks
(including existing "--" double-hyphen stand-ins), and en-dash (–) for
numeric ranges and the "Title – Subtitle" pattern already used by
Command-Line-Options.md, Privacy-Statement.md, and 2020-03-28-Server-Rpi.md
(404.html's title used a plain hyphen for the same pattern; now consistent).

Compound words, CLI flags, list bullets, ISO dates, and code spans are
untouched -- those hyphens are already correct.
@mcfnord

mcfnord commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

The standard should be use of reliable typographical features for the intended audience. I think this implies that natural language content in the main repo should be ASCII, and content in this repo rendered on browsers for our largest audience should use the full spectrum of reliable English typography.

@pljones

pljones commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

I can't type those characters. That should be the determining factor for the character set used in the web site source code.

I can type – and —, where it's important enough.

If we referred to money, I'd say use £ not £, too.

@mcfnord

mcfnord commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

I can't type those characters. That should be the determining factor for the character set used in the web site source code.

How did i make this PR in 2 minutes without typing any of those? Even updating any 1967-genre text you might type is now blindingly fast and easy.

mcfnord pushed a commit to mcfnord/jamuluswebsite that referenced this pull request Jul 23, 2026
Moves the substantive dash/hyphen/quote/ellipsis guidance into
Style-and-Tone.md (applies to all contributors, not just agents) next
to the existing Units section, which does the same kind of
micro-convention work. AGENTS.md keeps a pointer plus the one rule
that's genuinely agent-specific: check the diff for stray curly
characters near code, since that's an LLM/paste failure mode rather
than a human typing habit.

Unifies the two prior asks in this area: the original "always straight
ASCII" quotes rule (safe wherever the text could be pasted into a
shell/JSON/regex/code span) and the "use en/em dash where typography
calls for it" split from PR jamulussoftware#1159, under one principle -- machine
context stays ASCII, human-read prose gets the correct character.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants