docs: stop using -- as a dash, and fail CI on it - #72
Merged
Merged
Conversation
-- is for command lines: flags, git's end-of-options separator, and the like. It had been standing in for a dash in 26 places: METHODOLOGY, the docstrings and comments of six source files, a test, an example, and one report string, the load summary's note on ordinal-score rows. Each now uses a comma, colon, or parentheses. The example report carries the same note, so it changes with it; the site build still finds it identical, line for line, to what its command prints. A second step in CI's prose job fails on a bare -- between words, or one opening a continuation line, across the markdown, src/, tests/, examples/, site/, and scripts/. A flag has no space after its dashes, and HTML comments and table rules have no word before them, so none of those trip it. It finds all 26 on main and nothing now. The site smoke test's failure marker was a "--" too; it is now FAIL. Closes #54. This changes report text, not any number. Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
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.
--belongs to command lines (flags, git's end-of-options separator) and nowhere else. It had been standing in for a dash in 26 places. Each now uses a comma, colon or parentheses, whichever the sentence wanted.Closes #54.
What changed
config.py,loader.py,baseline.py,markdown.pyandtypes.py.conftest.py, one test, and one example.docs/example-report.mdcarries that note, so it changed with it. The site build compares the report line for line with what its command prints, and it still passes. This changes report text, not any number.--. It is nowFAIL.prosejob fails on a bare--between words, or one opening a continuation line. It scans the markdown,src/,tests/,examples/,conftest.py,site/andscripts/.--adapter) have no space after the dashes, and HTML comments (<!--) and table rules (|--:|) have no word before them, so none of these trip it.mainit finds all 26. On this branch it finds none. A probe of real command lines and an HTML comment matched nothing.--separator inbuild_site.pyand in the workflow.Checked:
ruff,mypy --strict, andpytestpass. The site build (including the example-report comparison),check_floor_parity,check_site_links, andsmoke_siteall pass. The em-dash check is also clean.🤖 Generated with Claude Code