Skip to content

Normalize repository-owned spelling in test support - #537

Open
leynos wants to merge 1 commit into
test-quality-sweep-git-fixture-pre-movefrom
harden-lint-spelling
Open

leynos wants to merge 1 commit into
test-quality-sweep-git-fixture-pre-movefrom
harden-lint-spelling

Conversation

@leynos

@leynos leynos commented Sep 23, 2026 •

Copy link
Copy Markdown
Owner

Summary

This branch corrects repository-owned Oxford spelling in Rust test support and
maintainer documentation. Tracing snapshot names and their callers change
together, while externally fixed names and behaviour remain unchanged. It
follows PR #538 in the Rust
baseline train and precedes the structural module-move layer.

Review walkthrough

Validation

  • The one-commit layer replayed from old Propagate Git fixture setup failures #538 head
    a107814589b42de131072272b4f04d5405c9f145 onto Propagate Git fixture setup failures #538
    a20c2cd29bc614db827970717ae124b18d83722f. Range-diff is 1:1,
    stable patch ID 9dfcf4cbab6dc9c4684d6026546995dbab3d3cda is unchanged,
    and git diff --check is clean.
  • All eight Make gates passed sequentially on exact head
    b7782957c402748ddc698ba1b8ee93984e628bf1:
    make check-fmt, make lint, make typecheck, make test,
    make markdownlint, make nixie, make verus, and
    make verus-selftest. Logs: /tmp/pr537-restack-<gate>-b778295.out.
  • Local CodeScene CLI delta against Propagate Git fixture setup failures #538 found no issues.
  • Exact-head CI run 35960430500
    passed all six jobs, including build-test, Windows atomic-write and four
    packaging jobs. Verus run 35960430532,
    hosted CodeScene result 7670166 and Gecko also passed. Codex review remains
    pending; managed CodeRabbit request b84ea1bb is queued.
  • PR Propagate Git fixture setup failures #538 supplies fallible Git BDD fixture setup below this branch.

Known baseline limits and deferred work

This repository has no make spelling target or generated typos.toml yet.
The pinned Concordat generator drops [phrases.corrections]; that upstream
input-loss defect is tracked in
Concordat #118. The source
spelling cleanup is independently reviewable, but does not claim a spelling
gate pass. The later generated-configuration layer requires a repaired,
approved pin and both positive and negative exemption tests.

The proposed final lint baseline also remains in later source-fix layers.
Phase 0 measured at least 997 Clippy sites and eight rustdoc errors before
remediation; integration-test targets were incompletely measured.

References

@coderabbitai

coderabbitai Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Team

Run ID: 89af0d93-0482-4f7b-834e-a942b4e5c6a4

📥 Commits

Reviewing files that changed from the base of the PR and between a20c2cd and b778295.

📒 Files selected for processing (8)
  • docs/developers-guide.md
  • src/io_tracing_tests.rs
  • src/process/buffer/tests.rs
  • src/wrap/inline/fragment_tracing_snapshots.rs
  • src/wrap/inline/span_helper_tracing_tests.rs
  • src/wrap/tokenize/parsing_tracing_snapshots.rs
  • src/wrap/tracing_snapshot_support.rs
  • tests/cli_diff.rs
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • leynos/netsuke (auto-detected)
  • leynos/df12-dylint-builds (auto-detected)
  • leynos/typos-config-builder (auto-detected)
  • leynos/falcon-correlate (auto-detected)
  • leynos/msgspec-crockford (auto-detected)
  • leynos/vk (auto-detected)
  • leynos/simulacat-core (auto-detected)
  • leynos/agent-template-python (auto-detected)
  • leynos/shared-actions (auto-detected)
  • leynos/cuprum (auto-detected)

Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


Summary

Standardize repository-owned spelling in Rust test support and maintainer documentation. Rename normalise_event_lines to normalize_event_lines and update its callers, examples and documentation. Correct related spelling in test comments and assertion messages.

Preserve test scenarios, assertions, normalization behaviour and snapshot output.

Walkthrough

The tracing snapshot helper and its references now use American spelling. Related documentation, comments, and assertion messages also use American spelling. Normalisation behaviour and test logic are unchanged.

Changes

Tracing helper spelling update

Layer / File(s) Summary
Rename helper and update references
src/wrap/tracing_snapshot_support.rs, src/io_tracing_tests.rs, src/wrap/inline/fragment_tracing_snapshots.rs, src/wrap/inline/span_helper_tracing_tests.rs, src/wrap/tokenize/parsing_tracing_snapshots.rs, docs/developers-guide.md, src/process/buffer/tests.rs, tests/cli_diff.rs
The helper declaration, tests, call sites, documentation, comments, and assertion messages use American spelling. Normalisation behaviour and test logic are unchanged.

Merge Risk: ⚪ Minimal · up to b7782

This change updates spelling in test support and documentation without changing the described behavior. No actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarises the spelling updates to repository-owned test support. No roadmap or issue reference is required because the change is not presented as implementing a roadmap task or f…
Description check ✅ Passed The description directly explains the spelling changes, affected tracing helpers, documentation, validation, and deferred work. It is relevant to the changeset.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 12 functions across 7 files. (1 skipped: 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Testing (Overall) ✅ Passed Pass the testing check. The authoritative PR diff contains only spelling and identifier renames in documentation, test support, and existing tests. The helper implementation and test logic remain unch…
User-Facing Documentation ✅ Passed Mark this check as passed. The PR changes only an internal pub(crate) test-support helper, its test callers, spelling in test diagnostics, and developer documentation. The diff introduces no user-fa…
Developer Documentation ✅ Passed Accept the documentation change. The renamed internal helper normalize_event_lines is documented in docs/developers-guide.md, including its module path, behaviour, ownership, call-site policy, and…
Module-Level Documentation ✅ Passed Pass this check. Every changed Rust module has module-level //! documentation that states its purpose and, where relevant, its role in tracing tests or support. The nested proptests module also ha…
Testing (Unit And Behavioural) ✅ Passed Pass this check. The pull-request range changes only spelling in the helper name, comments, documentation, and assertion text. The helper implementation and test logic remain unchanged. Existing prope…
Testing (Property / Proof) ✅ Passed Pass this check. The pull request only renames normalise_event_lines to normalize_event_lines and updates spelling in documentation, comments, and assertion text. The helper logic and its existing…
Testing (Compile-Time / Ui) ✅ Passed Pass this check. The PR changes only test-support identifiers, comments, documentation, and assertion wording; it does not introduce compile-time behaviour or a new UI/output contract. The existing Ru…
Unit Architecture ✅ Passed The pull request only renames a test snapshot helper and related test/documentation wording. The helper keeps the same (&[&str], &str) -> String shape and unchanged normalization logic; all callers …
Domain Architecture ✅ Passed Pass the Domain Architecture check. The reviewed diff changes only Oxford/American spelling in test helpers, assertions, comments, and developer documentation. The normalize_event_lines function bod…
Observability ✅ Passed Mark PASS. The reviewed diff only renames a test-support helper and related test, documentation, and diagnostic text. It does not alter production operations, failure modes, throughput, latency, or se…

Rename the helper; keep its work the same.
Update each call and each mention by name.
Let snapshots retain their familiar shape.
Keep test assertions unchanged in scope.
Spell the references with care.
Leave normalisation behaviour there.

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

@sourcery-ai

sourcery-ai Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

This PR applies repository-owned Oxford-to-American spelling normalization across tracing snapshot support, its callers, maintainer guidance, and test prose. The helper rename is propagated consistently through implementation, doctests, property tests, and integration tests, while runtime behavior, externally fixed names, and snapshot semantics remain unchanged.

File-Level Changes

Change Details Files
Renamed the repository-owned tracing snapshot normalization helper and updated its implementation, documentation, property tests, and all Rust test callers consistently.
  • Renamed normalise_event_lines to normalize_event_lines in the support module and doctest.
  • Updated tracing snapshot callers across I/O, inline, and tokenization tests.
  • Renamed related property-test module items and terminology while preserving filtering, prefix-stripping, trimming, and snapshot behavior.
src/wrap/tracing_snapshot_support.rs
src/io_tracing_tests.rs
src/wrap/inline/fragment_tracing_snapshots.rs
src/wrap/inline/span_helper_tracing_tests.rs
src/wrap/tokenize/parsing_tracing_snapshots.rs
Normalized Oxford spelling in repository-owned prose and test diagnostics without changing test behavior.
  • Changed normalise to normalize in developer guidance and a buffer test message.
  • Changed localise to localize in CLI diff test documentation and assertion text.
docs/developers-guide.md
src/process/buffer/tests.rs
tests/cli_diff.rs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@leynos
leynos marked this pull request as ready for review September 23, 2026 21:57

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry @leynos, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 12 hours and 50 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-23T22:00:38.376494Z 44735e3 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

codescene-access[bot]

This comment was marked as outdated.

@leynos
leynos changed the base branch from test-quality-sweep-assert-locations to test-quality-sweep-git-fixture-pre-move September 23, 2026 22:32
@leynos
leynos force-pushed the test-quality-sweep-git-fixture-pre-move branch from a107814 to a20c2cd Compare September 24, 2026 05:26
Rename the tracing snapshot helper and its references to Oxford spelling.
Update nearby test diagnostics and developer documentation so the source
uses the same convention without changing output contracts.
@leynos
leynos force-pushed the harden-lint-spelling branch from 95c7295 to b778295 Compare September 24, 2026 05:32
@pandalump

Copy link
Copy Markdown
Collaborator

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

This branch has not been deployed

No deployments
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.

2 participants