docs: plain voice pass over comments, docstrings, and docs#98
Merged
Conversation
Rewrite generated prose in plain declarative sentences: 635 em dashes and 22 double-hyphen dashes removed across Python, Rust, Swift, and markdown, each a real rewrite (sentence splits, comma and parenthetical folds, label colons), never a punctuation swap. String literals, table cells, code fences, and the canonical-JSON fixtures keep their dashes. Also drop two roadmap references from public doc-comments.
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
2 participants
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.
Comments, docstrings, and markdown across the repo carried a generated register, em dashes above all. This rewrites that prose in plain declarative sentences: 635 em dashes and 22 double-hyphen dashes removed, each a real rewrite (sentence splits, comma and parenthetical folds, colons only where a label introduces its expansion), never a punctuation swap.
Deliberately unchanged: string literals (error messages, CLI help strings, plot labels), table cells, code fences, the canonical-JSON unicode fixtures, and third_party/. Two roadmap references also left public doc-comments.
Checks: ruff clean, cargo check clean, every changed file compiles, targeted pytest on the touched test files passes. Text only; no code, identifiers, or literals changed.