Skip to content

chore: strip AI-writing typography across the repo - #7

Merged
yaniswav merged 1 commit into
mainfrom
chore/sanitize-ai-typography
Aug 22, 2026
Merged

chore: strip AI-writing typography across the repo#7
yaniswav merged 1 commit into
mainfrom
chore/sanitize-ai-typography

Conversation

@yaniswav

@yaniswav yaniswav commented Aug 22, 2026

Copy link
Copy Markdown
Owner

Replaces the typographic markers that read as machine-generated text with plain ASCII punctuation, across docs, code comments, docstrings, config and metadata.

Content is unchanged. This is punctuation, not rewriting. The diff is symmetric: 1575 insertions, 1575 deletions, no line added or removed.

What was replaced

Marker Count Treatment
Em dash 1347 Contextual: colon under a heading, parentheses around an aside, full stop where a sentence was being extended, semicolon inside an existing parenthesis. Never a uniform substitution, which would break grammar.
Arrows 237 ->, <-, <->
Section sign 104 "section N"
French guillemets 38 "
Math and misc symbols ~30 >=, <=, x, ~, ...
Status emoji ~40 Replaced by the words they stood for, so comparison tables keep their value instead of an empty cell

What was deliberately kept

  • French accented characters. They are the language, not typography.
  • The tree-style directory diagram in README.md. That is what the tree command emits; rendering it as ASCII art would look more contrived, not less.
  • One U+FFFD in audit-post-v0.4.0.md. It documents a real corrupted-BOM artifact the audit observed; removing it would erase the evidence.

Lexical markers were a non-issue

Of 24 raw matches for the usual vocabulary, all 24 were false positives: underscore refers to the _ character, unlock to license gating, landscape to the competitive landscape, robust to test robustness. The signal in this repo was purely typographic.

Where a blind replacement would have broken something

  • # pragma: no cover left intact; only the text after it changed. It is a magic token for coverage.py.
  • Em dashes used as "no value" placeholders in traction tables became -, never a comma.
  • Five section headings in TESTING.md changed, so their GitHub anchor slugs changed. The five internal links were recomputed and updated.
  • Percent-encoded em dashes inside mailto: subjects in pro.md were invisible in source but would have rendered in the recipient's mail client.
  • scripts/traction-snapshot.sh emits documentation via echo, so its string literals needed the same treatment. Re-run end to end to confirm the generated summary is clean.
  • CHANGELOG version headings, dates and comparison links verified byte-identical before and after, since published release notes link to those anchors.

Public surfaces, updated to match

The repository description and all six GitHub release titles and bodies were rewritten too, since they carried the same markers and are the first thing a visitor reads. All now scan clean.

Verification

  • ruff check src tests clean, ruff format --check src clean
  • pytest 484 passed, 24 skipped (unchanged from baseline)
  • server.json still validates against the MCP Registry schema
  • bash -n scripts/traction-snapshot.sh valid, script re-run end to end
  • Server builds in mock mode; 22 server/tool integration tests pass

https://claude.ai/code/session_01Us8nLW5XexX1N28nb3dgUp

yaniswav
chore: strip AI-writing typography across the repo
e733172 
Replaces the typographic markers that read as machine-generated text with
plain ASCII punctuation, across docs, code comments, docstrings, config
and metadata. Content is unchanged: this is punctuation, not rewriting.
The diff is symmetric (1575 insertions, 1575 deletions), no line added or
removed.

What was replaced, and how:

- 1347 em dashes. Not by a uniform substitution, which would break
  grammar: a colon under a heading, parentheses around an aside, a full
  stop where a sentence was being extended, a semicolon inside an
  existing parenthesis.
- 237 arrows, 104 section signs, 38 French guillemets, plus assorted
  math and box-drawing symbols, all converted to ASCII equivalents.
- Status emoji in headings and tables replaced by the words they stood
  for, so a comparison table keeps its value instead of an empty cell.

What was deliberately kept:

- French accented characters. They are the language, not typography.
- The `tree`-style directory diagram in README.md. That is what the
  `tree` command emits; rendering it in ASCII art would look more
  contrived, not less.
- One U+FFFD in audit-post-v0.4.0.md. It documents a real corrupted-BOM
  artifact the audit observed; removing it would erase the evidence.

Lexical markers turned out to be a non-issue. Of 24 raw matches for the
usual vocabulary, all 24 were false positives: `underscore` refers to
the `_` character, `unlock` to license gating, `landscape` to the
competitive landscape. The signal in this repo was purely typographic.

Care taken where a blind replacement would have broken something:

- `# pragma: no cover` left intact; only the text after it changed.
- Em dashes used as "no value" placeholders in traction tables became
  `-`, never a comma.
- Five section headings in TESTING.md changed, so their GitHub anchor
  slugs changed; the five internal links were recomputed and updated.
- Percent-encoded em dashes inside mailto: subjects in pro.md were
  invisible in source but would have rendered in the recipient's mail
  client.
- scripts/traction-snapshot.sh emits documentation via echo, so its
  string literals needed the same treatment; re-run end to end to
  confirm the generated summary is clean.

Verified: ruff clean, ruff format clean, 484 passed / 24 skipped
(unchanged), server.json still validates against the registry schema,
shell script syntax valid, server builds in mock mode.

Claude-Session: https://claude.ai/code/session_01Us8nLW5XexX1N28nb3dgUp
Copilot AI lite review requested due to automatic review settings August 22, 2026 21:06
@yaniswav
yaniswav merged commit 7b225f9 into main Aug 22, 2026
7 checks passed
@yaniswav
yaniswav deleted the chore/sanitize-ai-typography branch August 22, 2026 21:09
Copilot AI reviewed Aug 22, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Restore or separate the unrelated PyPI metric changes in both tracked traction artifacts.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This pull request replaces machine-like typographic markers with plain ASCII punctuation across the repository.

Changes:

  • Standardizes punctuation and symbols across code, tests, documentation, configuration, and metadata.
  • Updates generated output and Markdown anchors.
  • Changes tracked PyPI traction metrics in two generated artifacts; these unrelated data changes require correction.
File summaries
File Summary
tests/test_xtypes.py Test documentation punctuation cleanup.
tests/test_topic_metrics.py Test documentation punctuation cleanup.
tests/test_tools_integration.py Test comments and documentation cleanup.
tests/test_telemetry.py Test documentation punctuation cleanup.
tests/test_qos_endpoints.py Test comments cleanup.
tests/test_qos_analyzer.py Test comments and docstrings cleanup.
tests/test_pro_hook.py Test comments and docstrings cleanup.
tests/test_peek_bag_samples.py Test docstring punctuation cleanup.
tests/test_opendds_adapter.py Test comments and docstrings cleanup.
tests/test_mock_adapter.py Test comments and docstrings cleanup.
tests/test_metrics_buffer.py Test comments and docstrings cleanup.
tests/test_live_adapter_subprocess.py Test comments and docstrings cleanup.
tests/test_live_adapter_parse.py Test comments and docstrings cleanup.
tests/test_lifecycle_buffer.py Test comments and docstrings cleanup.
tests/test_health.py Test comments and docstrings cleanup.
tests/test_fast_adapter.py Test documentation punctuation cleanup.
tests/test_factory.py Test documentation punctuation cleanup.
tests/test_dust_adapter.py Test documentation punctuation cleanup.
tests/test_dds_qos_normalization.py Test documentation punctuation cleanup.
tests/test_dds_introspection.py Test comments cleanup.
tests/test_dds_helpers.py Test comments and docstrings cleanup.
tests/test_dds_cross_vendor.py Test documentation punctuation cleanup.
tests/test_cyclone_adapter.py Test documentation punctuation cleanup.
tests/test_config.py Test documentation punctuation cleanup.
tests/test_composite_adapter.py Test comments and docstrings cleanup.
tests/test_cdr_decoder.py Test documentation punctuation cleanup.
tests/test_bag_service.py Test comments and docstrings cleanup.
tests/test_analyze_bag_multi_format.py Test docstring punctuation cleanup.
tests/integration/test_scenarios_schema.py Integration-test comments and messages cleanup.
tests/integration/test_real_bus.py Integration-test comments and messages cleanup.
tests/integration/__init__.py Package documentation cleanup.
tests/fixtures/csv_echo_pose_multi.txt Fixture comments cleanup.
tests/fixtures/csv_echo_imu.txt Fixture comments cleanup.
src/topicforge/telemetry/client.py Documentation and docstring cleanup.
src/topicforge/telemetry/__init__.py Module documentation cleanup.
src/topicforge/services/inspector.py Documentation cleanup.
src/topicforge/services/health.py Comments and docstrings cleanup.
src/topicforge/services/factory.py Documentation and message cleanup.
src/topicforge/services/bag_service.py Documentation and comments cleanup.
src/topicforge/services/__init__.py Module documentation cleanup.
src/topicforge/server/app.py Module documentation cleanup.
src/topicforge/models/schemas.py Schema descriptions and comments cleanup.
src/topicforge/models/__init__.py Module documentation cleanup.
src/topicforge/constants.py Module documentation cleanup.
src/topicforge/config/settings.py Comments and docstrings cleanup.
src/topicforge/adapters/ros2_mock/fixtures.py Fixture comments and text cleanup.
src/topicforge/adapters/ros2_mock/adapter.py Module documentation cleanup.
src/topicforge/adapters/ros2_live/adapter.py Documentation and comments cleanup.
src/topicforge/adapters/ros2_live/__init__.py Module documentation cleanup.
src/topicforge/adapters/dds_opendds/adapter.py Documentation and messages cleanup.
src/topicforge/adapters/dds_opendds/__init__.py Module documentation cleanup.
src/topicforge/adapters/dds_fast/adapter.py Documentation and comments cleanup.
src/topicforge/adapters/dds_fast/__init__.py Module documentation cleanup.
src/topicforge/adapters/dds_dust/adapter.py Documentation and messages cleanup.
src/topicforge/adapters/dds_dust/__init__.py Module documentation cleanup.
src/topicforge/adapters/dds_cyclone/adapter.py Documentation and comments cleanup.
src/topicforge/adapters/dds_cyclone/__init__.py Module documentation cleanup.
src/topicforge/adapters/composite.py Documentation and comments cleanup.
src/topicforge/adapters/common/xtypes.py Documentation and docstrings cleanup.
src/topicforge/adapters/common/qos_normalize.py Documentation and docstrings cleanup.
src/topicforge/adapters/common/qos_endpoints.py Documentation and comments cleanup.
src/topicforge/adapters/common/qos_analyzer.py Documentation and comments cleanup.
src/topicforge/adapters/common/metrics_buffer.py Documentation and comments cleanup.
src/topicforge/adapters/common/lifecycle.py Documentation and comments cleanup.
src/topicforge/adapters/common/dds_introspection.py Documentation and docstrings cleanup.
src/topicforge/adapters/common/dds_helpers.py Documentation and messages cleanup.
src/topicforge/adapters/common/cdr_decoder.py Documentation and comments cleanup.
src/topicforge/adapters/common/__init__.py Module documentation cleanup.
src/topicforge/adapters/base.py Protocol documentation cleanup.
src/topicforge/adapters/__init__.py Module documentation cleanup.
src/topicforge/__init__.py Package documentation cleanup.
SECURITY.md Security documentation punctuation cleanup.
scripts/traction-snapshot.sh Generated-summary formatting cleanup.
scripts/integration/scenarios_runner.py Output formatting and comments cleanup.
scripts/integration/README.md Integration documentation cleanup.
scripts/integration/publishers/opendds_publisher.py Diagnostic text cleanup.
scripts/integration/publishers/fast_publisher.py Module documentation cleanup.
scripts/integration/publishers/cyclone_publisher.py Documentation and comments cleanup.
scripts/integration/docker/publisher-opendds/Dockerfile Comments cleanup.
scripts/integration/docker/publisher-fast/Dockerfile Comments cleanup.
scripts/integration/docker/publisher-cyclone/Dockerfile Comments cleanup.
scripts/integration/docker/publisher-cyclone/.dockerignore Comments cleanup.
scripts/integration/docker-compose.yml Comments cleanup.
pyproject.toml Configuration comments cleanup.
Makefile Help-text punctuation cleanup.
examples/README.md Examples documentation cleanup.
examples/04-monitor-topic-frequency.md Example punctuation cleanup.
examples/03-analyze-recording.md Example punctuation cleanup.
examples/02-debug-qos-mismatch.md Example punctuation cleanup.
examples/01-discover-ros2-stack.md Example punctuation cleanup.
docs/TROUBLESHOOTING.md Troubleshooting documentation cleanup.
docs/TESTING.md Headings, anchors, and documentation cleanup.
docs/projet-file/traction/README.md Traction documentation cleanup.
docs/projet-file/traction/latest-summary.md Contains unrelated PyPI metric changes; restore or separate the data refresh.
docs/projet-file/traction/2026-08-22.json Contains unrelated PyPI metric changes; restore or separate the data refresh.
docs/projet-file/references/README.md Reference documentation cleanup.
docs/projet-file/README.md Strategic documentation cleanup.
docs/projet-file/archive/README.md Archive documentation cleanup.
docs/projet-file/archive/launch-posts-v0.3.0/v0.3.0-reddit-ros.md Archived post cleanup.
docs/projet-file/archive/launch-posts-v0.3.0/v0.3.0-reddit-claudeai.md Archived post cleanup.
docs/projet-file/archive/launch-posts-v0.3.0/v0.3.0-linkedin.md Archived post cleanup.
docs/projet-file/archive/audits-v0.1.2/security-audit-v0.1.2.md Archived audit documentation cleanup.
docs/MIGRATION_v0.2_to_v0.3.md Migration documentation cleanup.
docs/MIGRATION_v0.1_to_v0.2.md Migration documentation cleanup.
docs/dds-interop-matrix.md Interoperability documentation cleanup.
CONTRIBUTING.md Contributor documentation cleanup.
.gitignore Comments cleanup.
.github/workflows/integration.yml Workflow comments cleanup.
.github/PULL_REQUEST_TEMPLATE.md Template text cleanup.
.github/ISSUE_TEMPLATE/feature_request.yml Template text cleanup.
.github/ISSUE_TEMPLATE/config.yml Template description cleanup.
.github/ISSUE_TEMPLATE/bug_report.yml Template text cleanup.
.env.example Configuration comments cleanup.
Review details

Suppressed comments (2)

docs/TESTING.md:9

  • Because the replacement colon starts a new Markdown line, this paragraph renders with a space before the punctuation (issues) : that's). Keep the colon on the link line (or use a full stop) so the cleanup does not introduce malformed punctuation.
: that's the highest-signal feedback for the current release.

docs/TROUBLESHOOTING.md:9

  • Because the replacement colon starts a new Markdown line, this paragraph renders with a space before the punctuation (issues) : the). Keep the colon on the link line (or use a full stop) so the cleanup does not introduce malformed punctuation.
: the troubleshooting list grows from real reports.
  • Files reviewed: 126/127 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/projet-file/traction/2026-08-22.json
Comment on lines +4 to +7
"status": "ok",
"last_day": 0,
"last_week": 1,
"last_month": 12
Comment thread docs/projet-file/traction/latest-summary.md
Comment on lines +5 to +7
| PyPI installs / day | 0 | rolling |
| PyPI installs / week | 1 | **G2 needs >= 100/week sustained over a month** |
| PyPI installs / month | 12 | rolling baseline |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@yaniswav