docs: remove em-dashes and AI-text tells from READMEs and docs - #108
Merged
Conversation
…ADME and CONTRIBUTING
…tion, tutorial, examples, development)
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 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. Comment |
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.
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.mdand the committed QC artifacts are deliberately untouched.Em-dash removal
README.md(20),CONTRIBUTING.md(3), alldocs/**/*.mdpages (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.docs/fullmap.mdsentence split in two. "Not applicable" Default cells in CLI tables becomen/a(9 cells indocs/cli.md,docs/agent.md).subject-predicate-object,gene-disease,microbiome-chemical); the typographically correct numeric range0–3indocs/agent.mdis kept.AI-tell cleanup
[\"yaml\"]" becomes "is exactly ..." indocs/agent.md; "simply omit" becomes "omit" indocs/configuration/table.md.Additionally/Moreover/Furthermore, no negative parallelisms across in-scope files.Design
docs/installation.mdsample CLI output now differs from the real message insrc/tablassert/errors.py:147by one punctuation mark, because the source message itself contains an em-dash. Deferred: de-dashing source CLI messages belongs in a code PR.CHANGELOG.md(hand-written historical record) andexamples/agent/QC_REPORT.md/QC_REVIEW.md(tests/test_example_qc.pyparses their YAML fences and regex-matches the## PMC<n> — **rating** (config sha256: ...)heading format with sha256 cross-checks).docs/agent.md,docs/configuration/table.md,docs/installation.md); no headings, links, flags, keys, defaults, or numbers changed.Testing
uv run pytest→1007 passed, 38 skipped(skips are optional agent-extraimportorskips)uv run --no-sync mkdocs build --strict→ exit 0rg -l '—' --glob '*.md' .→ onlyCHANGELOG.md,examples/agent/QC_REPORT.md,examples/agent/QC_REVIEW.mdgit diff origin/main...HEAD -- CHANGELOG.md examples/agent/QC_REPORT.md examples/agent/QC_REVIEW.md→ empty