Rename BackoffConfig::normalised to BackoffConfig::normalized

[coderabbitai]

Description

Rename the method BackoffConfig::normalised to BackoffConfig::normalized to align with American English spelling conventions for this API.

Required Changes

• Rename method definition in src/server/runtime/backoff.rs (line 57)
• Update method call in src/server/runtime.rs (line 338)
• Update documentation references in src/server/config/mod.rs (lines 142, 146, 152)
• Update any relevant tests that reference the method name
• Update documentation that mentions the method

Breaking Change

This is a breaking API change and should be released as part of a 0.x point release.

Related

• PR: Align docs to en-GB-oxendict spelling; add migration guide #440
• Requested by: @leynos in Align docs to en-GB-oxendict spelling; add migration guide #440 (comment)

[traycerai]

Plan

Observations

The codebase is a Rust project for a wireframe server library. The BackoffConfig::normalised method is a public API that normalizes backoff configuration values by clamping delays to valid ranges and swapping inverted values. It's used internally by the accept_backoff builder method and is referenced in multiple documentation locations. The method follows British English spelling ("normalised"), which needs to be changed to American English ("normalized") for consistency with the project's API conventions.

Approach

This is a straightforward API renaming task requiring updates to the method definition, its usage, and all documentation references. The changes will be made across source files, inline documentation, and external documentation files. Since this is a breaking API change, all references must be updated atomically to maintain consistency. The implementation will follow the exact locations specified in the GitHub issue.

Implementation Steps

1. Update Method Definition

File: src/server/runtime/backoff.rs

• Rename the method normalised to normalized at line 58
• Update the doc comment example that references the method:
  • Line 52: Change let normalised = cfg.normalised(); to let normalized = cfg.normalized();
  • Lines 54-55: Update variable references from normalised.initial_delay and normalised.max_delay to normalized.initial_delay and normalized.max_delay

2. Update Method Call in Runtime

File: src/server/runtime.rs

• Update the method call at line 342 from backoff.normalised() to backoff.normalized()

3. Update Documentation in Config Module

File: src/server/config/mod.rs

• Update the doc comment for the accept_backoff builder method:
  • Line 146: Change [`BackoffConfig::normalised`] (`cfg.normalised()`) to [`BackoffConfig::normalized`] (`cfg.normalized()`)
  • Line 147: Change BackoffConfig::normalised to BackoffConfig::normalized
  • Line 153: Change cfg.normalised() to cfg.normalized() in the macro invocation

4. Update External Documentation

File: docs/server/configuration.md

• Update line 58: Change BackoffConfig::normalised to BackoffConfig::normalized

5. Verification Steps

After making the changes, verify:

• All references to the old method name have been updated by running: grep -r "normalised" --include="*.rs" --include="*.md"
• The code compiles successfully: cargo build
• All tests pass: cargo test
• Documentation builds without warnings: cargo doc

Summary of Changes

File	Lines	Change
src/server/runtime/backoff.rs	52, 54, 55, 58	Method definition and doc example
src/server/runtime.rs	342	Method call
src/server/config/mod.rs	146, 147, 153	Doc comments and macro
docs/server/configuration.md	62	User documentation

Import In IDE

🤖 Prompt for AI Agents

## Observations

The codebase is a Rust project for a wireframe server library. The `BackoffConfig::normalised` method is a public API that normalizes backoff configuration values by clamping delays to valid ranges and swapping inverted values. It's used internally by the `accept_backoff` builder method and is referenced in multiple documentation locations. The method follows British English spelling ("normalised"), which needs to be changed to American English ("normalized") for consistency with the project's API conventions.

## Approach

This is a straightforward API renaming task requiring updates to the method definition, its usage, and all documentation references. The changes will be made across source files, inline documentation, and external documentation files. Since this is a breaking API change, all references must be updated atomically to maintain consistency. The implementation will follow the exact locations specified in the GitHub issue.

## Implementation Steps

### 1. Update Method Definition

**File**: `src/server/runtime/backoff.rs`

- Rename the method `normalised` to `normalized` at line 58
- Update the doc comment example that references the method:
  - Line 52: Change `let normalised = cfg.normalised();` to `let normalized = cfg.normalized();`
  - Lines 54-55: Update variable references from `normalised.initial_delay` and `normalised.max_delay` to `normalized.initial_delay` and `normalized.max_delay`

### 2. Update Method Call in Runtime

**File**: `src/server/runtime.rs`

- Update the method call at line 342 from `backoff.normalised()` to `backoff.normalized()`

### 3. Update Documentation in Config Module

**File**: `src/server/config/mod.rs`

- Update the doc comment for the `accept_backoff` builder method:
  - Line 146: Change `` [`BackoffConfig::normalised`] (`cfg.normalised()`) `` to `` [`BackoffConfig::normalized`] (`cfg.normalized()`) ``
  - Line 147: Change `BackoffConfig::normalised` to `BackoffConfig::normalized`
  - Line 153: Change `cfg.normalised()` to `cfg.normalized()` in the macro invocation

### 4. Update External Documentation

**File**: `docs/server/configuration.md`

- Update line 58: Change `BackoffConfig::normalised` to `BackoffConfig::normalized`

### 5. Verification Steps

After making the changes, verify:

- All references to the old method name have been updated by running: `grep -r "normalised" --include="*.rs" --include="*.md"`
- The code compiles successfully: `cargo build`
- All tests pass: `cargo test`
- Documentation builds without warnings: `cargo doc`

### Summary of Changes

| File | Lines | Change |
|------|-------|--------|
| `src/server/runtime/backoff.rs` | 52, 54, 55, 58 | Method definition and doc example |
| `src/server/runtime.rs` | 342 | Method call |
| `src/server/config/mod.rs` | 146, 147, 153 | Doc comments and macro |
| `docs/server/configuration.md` | 62 | User documentation |

---

Execution Information

Branch: main
Commit: 7fbf62a

---

💡 Tips

Supported Commands (Inside Comments)

• Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

• Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
• Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[traycerai]

I have updated the Implementation Plan to reflect the recent changes in the ticket.

Previous Plan

Observations

The codebase is a Rust project for a wireframe server library. The BackoffConfig::normalised method is a public API that normalizes backoff configuration values by clamping delays to valid ranges and swapping inverted values. It's used internally by the accept_backoff builder method and is referenced in multiple documentation locations. The method follows British English spelling ("normalised"), which needs to be changed to American English ("normalized") for consistency with the project's API conventions.

Approach

This is a straightforward API renaming task requiring updates to the method definition, its usage, and all documentation references. The changes will be made across source files, inline documentation, and external documentation files. Since this is a breaking API change, all references must be updated atomically to maintain consistency. The implementation will follow the exact locations specified in the GitHub issue.

Implementation Steps

1. Update Method Definition

File: file:src/server/runtime/backoff.rs

• Rename the method normalised to normalized at line 58
• Update the doc comment example that references the method:
  • Line 52: Change let normalised = cfg.normalised(); to let normalized = cfg.normalized();
  • Lines 54-55: Update variable references from normalised.initial_delay and normalised.max_delay to normalized.initial_delay and normalized.max_delay

2. Update Method Call in Runtime

File: file:src/server/runtime.rs

• Update the method call at line 342 from backoff.normalised() to backoff.normalized()

3. Update Documentation in Config Module

File: file:src/server/config/mod.rs

• Update the doc comment for the accept_backoff builder method:
  • Line 146: Change [`BackoffConfig::normalised`] (`cfg.normalised()`) to [`BackoffConfig::normalized`] (`cfg.normalized()`)
  • Line 147: Change BackoffConfig::normalised to BackoffConfig::normalized
  • Line 153: Change cfg.normalised() to cfg.normalized() in the macro invocation

4. Update External Documentation

File: file:docs/server/configuration.md

• Update line 62: Change BackoffConfig::normalised to BackoffConfig::normalized

5. Verification Steps

After making the changes, verify:

• All references to the old method name have been updated by running: grep -r "normalised" --include="*.rs" --include="*.md"
• The code compiles successfully: cargo build
• All tests pass: cargo test
• Documentation builds without warnings: cargo doc

Summary of Changes

File	Lines	Change
src/server/runtime/backoff.rs	52, 54, 55, 58	Method definition and doc example
src/server/runtime.rs	342	Method call
src/server/config/mod.rs	146, 147, 153	Doc comments and macro
docs/server/configuration.md	62	User documentation

Import In IDE

🤖 Prompt for AI Agents

## Observations

The codebase is a Rust project for a wireframe server library. The `BackoffConfig::normalised` method is a public API that normalizes backoff configuration values by clamping delays to valid ranges and swapping inverted values. It's used internally by the `accept_backoff` builder method and is referenced in multiple documentation locations. The method follows British English spelling ("normalised"), which needs to be changed to American English ("normalized") for consistency with the project's API conventions.

## Approach

This is a straightforward API renaming task requiring updates to the method definition, its usage, and all documentation references. The changes will be made across source files, inline documentation, and external documentation files. Since this is a breaking API change, all references must be updated atomically to maintain consistency. The implementation will follow the exact locations specified in the GitHub issue.

## Implementation Steps

### 1. Update Method Definition

**File**: `file:src/server/runtime/backoff.rs`

- Rename the method `normalised` to `normalized` at line 58
- Update the doc comment example that references the method:
  - Line 52: Change `let normalised = cfg.normalised();` to `let normalized = cfg.normalized();`
  - Lines 54-55: Update variable references from `normalised.initial_delay` and `normalised.max_delay` to `normalized.initial_delay` and `normalized.max_delay`

### 2. Update Method Call in Runtime

**File**: `file:src/server/runtime.rs`

- Update the method call at line 342 from `backoff.normalised()` to `backoff.normalized()`

### 3. Update Documentation in Config Module

**File**: `file:src/server/config/mod.rs`

- Update the doc comment for the `accept_backoff` builder method:
  - Line 146: Change `` [`BackoffConfig::normalised`] (`cfg.normalised()`) `` to `` [`BackoffConfig::normalized`] (`cfg.normalized()`) ``
  - Line 147: Change `BackoffConfig::normalised` to `BackoffConfig::normalized`
  - Line 153: Change `cfg.normalised()` to `cfg.normalized()` in the macro invocation

### 4. Update External Documentation

**File**: `file:docs/server/configuration.md`

- Update line 62: Change `BackoffConfig::normalised` to `BackoffConfig::normalized`

### 5. Verification Steps

After making the changes, verify:

- All references to the old method name have been updated by running: `grep -r "normalised" --include="*.rs" --include="*.md"`
- The code compiles successfully: `cargo build`
- All tests pass: `cargo test`
- Documentation builds without warnings: `cargo doc`

### Summary of Changes

| File | Lines | Change |
|------|-------|--------|
| `src/server/runtime/backoff.rs` | 52, 54, 55, 58 | Method definition and doc example |
| `src/server/runtime.rs` | 342 | Method call |
| `src/server/config/mod.rs` | 146, 147, 153 | Doc comments and macro |
| `docs/server/configuration.md` | 62 | User documentation |

---

Execution Information

Branch: main
Commit: 7fbf62a

New Plan

Observations

The codebase is a Rust project for a wireframe server library. The BackoffConfig::normalised method is a public API that normalizes backoff configuration values by clamping delays to valid ranges and swapping inverted values. It's used internally by the accept_backoff builder method and is referenced in multiple documentation locations. The method follows British English spelling ("normalised"), which needs to be changed to American English ("normalized") for consistency with the project's API conventions.

Approach

This is a straightforward API renaming task requiring updates to the method definition, its usage, and all documentation references. The changes will be made across source files, inline documentation, and external documentation files. Since this is a breaking API change, all references must be updated atomically to maintain consistency. The implementation will follow the exact locations specified in the GitHub issue.

Implementation Steps

1. Update Method Definition

File: src/server/runtime/backoff.rs

• Rename the method normalised to normalized at line 58
• Update the doc comment example that references the method:
  • Line 52: Change let normalised = cfg.normalised(); to let normalized = cfg.normalized();
  • Lines 54-55: Update variable references from normalised.initial_delay and normalised.max_delay to normalized.initial_delay and normalized.max_delay

2. Update Method Call in Runtime

File: src/server/runtime.rs

• Update the method call at line 342 from backoff.normalised() to backoff.normalized()

3. Update Documentation in Config Module

File: src/server/config/mod.rs

• Update the doc comment for the accept_backoff builder method:
  • Line 146: Change [`BackoffConfig::normalised`] (`cfg.normalised()`) to [`BackoffConfig::normalized`] (`cfg.normalized()`)
  • Line 147: Change BackoffConfig::normalised to BackoffConfig::normalized
  • Line 153: Change cfg.normalised() to cfg.normalized() in the macro invocation

4. Update External Documentation

File: docs/server/configuration.md

• Update line 58: Change BackoffConfig::normalised to BackoffConfig::normalized

5. Verification Steps

After making the changes, verify:

• All references to the old method name have been updated by running: grep -r "normalised" --include="*.rs" --include="*.md"
• The code compiles successfully: cargo build
• All tests pass: cargo test
• Documentation builds without warnings: cargo doc

Summary of Changes

File	Lines	Change
src/server/runtime/backoff.rs	52, 54, 55, 58	Method definition and doc example
src/server/runtime.rs	342	Method call
src/server/config/mod.rs	146, 147, 153	Doc comments and macro
docs/server/configuration.md	62	User documentation

Import In IDE

🤖 Prompt for AI Agents

## Observations

The codebase is a Rust project for a wireframe server library. The `BackoffConfig::normalised` method is a public API that normalizes backoff configuration values by clamping delays to valid ranges and swapping inverted values. It's used internally by the `accept_backoff` builder method and is referenced in multiple documentation locations. The method follows British English spelling ("normalised"), which needs to be changed to American English ("normalized") for consistency with the project's API conventions.

## Approach

This is a straightforward API renaming task requiring updates to the method definition, its usage, and all documentation references. The changes will be made across source files, inline documentation, and external documentation files. Since this is a breaking API change, all references must be updated atomically to maintain consistency. The implementation will follow the exact locations specified in the GitHub issue.

## Implementation Steps

### 1. Update Method Definition

**File**: `src/server/runtime/backoff.rs`

- Rename the method `normalised` to `normalized` at line 58
- Update the doc comment example that references the method:
  - Line 52: Change `let normalised = cfg.normalised();` to `let normalized = cfg.normalized();`
  - Lines 54-55: Update variable references from `normalised.initial_delay` and `normalised.max_delay` to `normalized.initial_delay` and `normalized.max_delay`

### 2. Update Method Call in Runtime

**File**: `src/server/runtime.rs`

- Update the method call at line 342 from `backoff.normalised()` to `backoff.normalized()`

### 3. Update Documentation in Config Module

**File**: `src/server/config/mod.rs`

- Update the doc comment for the `accept_backoff` builder method:
  - Line 146: Change `` [`BackoffConfig::normalised`] (`cfg.normalised()`) `` to `` [`BackoffConfig::normalized`] (`cfg.normalized()`) ``
  - Line 147: Change `BackoffConfig::normalised` to `BackoffConfig::normalized`
  - Line 153: Change `cfg.normalised()` to `cfg.normalized()` in the macro invocation

### 4. Update External Documentation

**File**: `docs/server/configuration.md`

- Update line 58: Change `BackoffConfig::normalised` to `BackoffConfig::normalized`

### 5. Verification Steps

After making the changes, verify:

- All references to the old method name have been updated by running: `grep -r "normalised" --include="*.rs" --include="*.md"`
- The code compiles successfully: `cargo build`
- All tests pass: `cargo test`
- Documentation builds without warnings: `cargo doc`

### Summary of Changes

| File | Lines | Change |
|------|-------|--------|
| `src/server/runtime/backoff.rs` | 52, 54, 55, 58 | Method definition and doc example |
| `src/server/runtime.rs` | 342 | Method call |
| `src/server/config/mod.rs` | 146, 147, 153 | Doc comments and macro |
| `docs/server/configuration.md` | 62 | User documentation |

---

Execution Information

Branch: main
Commit: 7fbf62a