Normalize internal API spelling - #236
Open
leynos wants to merge 1 commit into
Open
Conversation
Rename internal spelling identifiers and call sites to Oxford `-ize` forms, and align diagnostics, test fixtures, and documentation. Refresh the generated spelling configuration so inline API references are checked.
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (45)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
💤 Files with no reviewable changes (1)
Included review availability: 4 reviews are currently available. Based on recent review activity, included reviews refill at 5 per hour. SummaryStandardize internal API identifiers and call sites on Oxford spelling, including
ValidationFormatting, linting, tests, type checking, spelling, Markdown linting, and Nixie validation pass. The test suite reports 765 tests and 72 snapshots. WalkthroughThe pull request standardises spelling across public and private identifiers, documentation, tests, diagnostics, examples, and typo-checking configuration. Runtime behaviour remains unchanged. ChangesSpelling normalisation
Possibly related PRs
Suggested reviewers: Poem
Merge Risk: ⚪ Minimal · up to This PR standardizes internal API spelling and updates its references; the supplied validation checks pass, and no actionable merge-blocking risk remains. 🚥 Pre-merge checks | ✅ 18 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (18 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Reviewer's GuideStandardizes internal APIs and surrounding diagnostics/tests/docs on Oxford spelling (notably Sequence diagram for compiletest stderr artefact diagnostics formattingsequenceDiagram
actor Caller
participant append as _append_compiletest_diagnostics
participant discover as _discover_stderr_artefacts
participant trim as _trim_artefact_token
participant format as _format_artefact_diagnostics
Caller->>append: _append_compiletest_diagnostics(message, stdout, stderr, tail_lines)
append->>discover: _discover_stderr_artefacts(stdout)
discover->>trim: _trim_artefact_token(token)
trim-->>discover: trimmed_token
discover-->>append: tuple[Path]
append->>discover: _discover_stderr_artefacts(stderr)
discover->>trim: _trim_artefact_token(token)
trim-->>discover: trimmed_token
discover-->>append: tuple[Path]
append->>format: _format_artefact_diagnostics(artefact, tail_lines)
format-->>append: list[str]
append-->>Caller: augmented_message
Flow diagram for normalize_workspace_root usage across modulesflowchart LR
subgraph utils
A[normalize_workspace_root]
end
B[cli.main]
C[bump._initialize_bump_context]
D[publish.run]
E[config.build_loader]
F[workspace.metadata.load_cargo_metadata]
B --> A
C --> A
D --> A
E --> A
F --> A
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![codescene-access[bot]](https://avatars.githubusercontent.com/in/3755875?s=60&v=4){kind=small}
There was a problem hiding this comment.
Our agent can fix these. Install it.
Gates Passed
Absence of Expected Change Pattern
- lading/lading/commands/publish.py is usually changed with: lading/tests/bdd/steps/test_publish_steps.py
Quality Gate Profile: Pay Down Tech Debt
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.
leynos
marked this pull request as ready for review
August 16, 2026 18:40
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7ba89a84a4
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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
1 participant
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.
Summary
This branch standardizes internal API identifiers and call sites on Oxford
British spelling, using
-izeforms andartefactwhere applicable. It alsoupdates diagnostics, tests and documentation so every internal reference uses
the renamed APIs.
The generated spelling configuration now checks inline code, preventing the
previous documentation/API mismatch from recurring.
Review walkthrough
normalize_workspace_rootAPI.Validation
make check-fmt: passedmake lint: passedmake test: passed (765 tests, 72 snapshots)make typecheck: passedmake spelling: passed (15 spelling-policy tests)make markdownlint: passedmake nixie: passedReferences