Skip to content

docs: remove em-dashes and AI-text tells from READMEs and docs - #108

Merged
SkyeAv merged 7 commits into
mainfrom
docs/remove-em-dashes-ai-tells
Aug 21, 2026
Merged

docs: remove em-dashes and AI-text tells from READMEs and docs#108
SkyeAv merged 7 commits into
mainfrom
docs/remove-em-dashes-ai-tells

Conversation

@SkyeAv

@SkyeAv SkyeAv commented Aug 21, 2026

Copy link
Copy Markdown
Owner

Removes all 277 em-dash occurrences from the project's READMEs and docs (plus one in the PR template) and normalizes the small set of AI-associated phrasing patterns, with no technical content changed. CHANGELOG.md and the committed QC artifacts are deliberately untouched.

Em-dash removal

  • 277 + 1 dashes removed across 21 files: README.md (20), CONTRIBUTING.md (3), all docs/**/*.md pages (233), examples/agent/README.md (7), tests/fixtures/edgecount/README.md (8), tests/agent_fixtures/PMC11708054/README.md (6), and 1 in .github/pull_request_template.md.
  • Context-appropriate replacements, never blanket: bold-lead bullets keep house style with colon separators; parenthetical asides become commas or parentheses; sentence breaks become periods or semicolons; one heavy docs/fullmap.md sentence split in two. "Not applicable" Default cells in CLI tables become n/a (9 cells in docs/cli.md, docs/agent.md).
  • En-dash policy: compounds normalized (subject-predicate-object, gene-disease, microbiome-chemical); the typographically correct numeric range 0–3 in docs/agent.md is kept.

AI-tell cleanup

  • Softeners removed: "is just [\"yaml\"]" becomes "is exactly ..." in docs/agent.md; "simply omit" becomes "omit" in docs/configuration/table.md.
  • Zero tells confirmed by regex gate: no banned vocabulary (delve, seamless, robust, comprehensive, etc.), no sentence-initial Additionally/Moreover/Furthermore, no negative parallelisms across in-scope files.

Design

  • Accepted caveat: the docs/installation.md sample CLI output now differs from the real message in src/tablassert/errors.py:147 by one punctuation mark, because the source message itself contains an em-dash. Deferred: de-dashing source CLI messages belongs in a code PR.
  • Excluded on purpose, byte-identical: CHANGELOG.md (hand-written historical record) and examples/agent/QC_REPORT.md / QC_REVIEW.md (tests/test_example_qc.py parses their YAML fences and regex-matches the ## PMC<n> — **rating** (config sha256: ...) heading format with sha256 cross-checks).
  • Deferred: README badge-wall removal (not an AI-text tell).
  • Code fences are byte-identical except three authorized sample-comment fixes (docs/agent.md, docs/configuration/table.md, docs/installation.md); no headings, links, flags, keys, defaults, or numbers changed.

Testing

  • uv run pytest1007 passed, 38 skipped (skips are optional agent-extra importorskips)
  • uv run --no-sync mkdocs build --strict → exit 0
  • rg -l '—' --glob '*.md' . → only CHANGELOG.md, examples/agent/QC_REPORT.md, examples/agent/QC_REVIEW.md
  • git diff origin/main...HEAD -- CHANGELOG.md examples/agent/QC_REPORT.md examples/agent/QC_REVIEW.md → empty

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b540cb54-8585-4342-a96d-1b143ed58774


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@SkyeAv
SkyeAv merged commit abb042a into main Aug 21, 2026
5 checks passed
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.

1 participant