Skip to content

docs(typed-fault): batch the epic #206 review doc nits onto one car#290

Open
mfw78 wants to merge 10 commits into
developfrom
docs/typed-fault-review-nits
Open

docs(typed-fault): batch the epic #206 review doc nits onto one car#290
mfw78 wants to merge 10 commits into
developfrom
docs/typed-fault-review-nits

Conversation

@mfw78

@mfw78 mfw78 commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

What

A single top-of-train car collecting eleven doc and comment rewords raised in the epic #206 review. Every change is rustdoc or comment only; no code behaviour moves.

Why

These regions are review hotspots already rewritten across the typed-fault stack, so the nits are collected onto one top car to avoid rippling every lower car in the train. Each reword lands on the tip's final content, located by content rather than by the reviewers' stale line numbers.

Testing

Per touched crate (nexum-sdk, nexum-runtime, shepherd-cow-host, shepherd-sdk) under the project nix shell: cargo fmt -p <crate> -- --check on the edited files, cargo clippy -p <crate> --all-targets -- -D warnings, and RUSTDOCFLAGS="-D warnings" cargo doc -p <crate> --no-deps (also --document-private-items for shepherd-cow-host to confirm the retargeted intra-doc link resolves). All clean.

AI Assistance

AI Assistance: Claude Code (Opus 4.8) used for the doc rewords and PR authoring.

@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from d6b095d to 4ba9912 Compare July 8, 2026 12:02
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 5340905 to 84542b5 Compare July 8, 2026 12:10
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from 4ba9912 to ff47c54 Compare July 8, 2026 12:10
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 84542b5 to 711da09 Compare July 8, 2026 12:20
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from ff47c54 to b858d44 Compare July 8, 2026 12:20
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 711da09 to 6346d1f Compare July 8, 2026 12:50
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from b858d44 to a5ff06e Compare July 8, 2026 12:50
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 6346d1f to 5271b4a Compare July 8, 2026 13:45
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from a5ff06e to c71c52e Compare July 8, 2026 13:45
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 5271b4a to 454c904 Compare July 8, 2026 14:00
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from c71c52e to 3a0a374 Compare July 8, 2026 14:00
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 454c904 to 4fc6d4a Compare July 8, 2026 14:09
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from 3a0a374 to 1baf641 Compare July 8, 2026 14:09
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 4fc6d4a to 845029d Compare July 8, 2026 14:13
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from 1baf641 to 8c31790 Compare July 8, 2026 14:13

@jean-neiverth jean-neiverth left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Doc rewrites follow house style. No concerns.

@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 845029d to df45f97 Compare July 8, 2026 22:33
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch 3 times, most recently from e0ad37e to f4c6f30 Compare July 8, 2026 23:24
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from a6ec61a to 8f1affb Compare July 8, 2026 23:24
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from f4c6f30 to 8cd84f4 Compare July 8, 2026 23:29
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 8f1affb to 3825099 Compare July 8, 2026 23:29
mfw78 added 7 commits July 9, 2026 01:01
Return a BuildError naming the failing component slot (chain, store, or
extension) from ComponentsBuilder::build, instead of an opaque
anyhow::Result. The leaf ComponentBuilder::build stays anyhow because the
backends fail for heterogeneous reasons (I/O for the store, network for
the chain). Callers that propagate into anyhow keep working through the
std::error::Error conversion.
Pass the executor explicitly with .with_executor(&TokioExecutor) in the
CLI builder chain, rather than relying on the builder's implicit tokio
default. This names the launch root as the point where an embedder or a
non-tokio target substitutes its own executor. Behaviour-preserving: the
binary still spawns on tokio.
The RuntimeAddOns -> RuntimeAddOn rename shortened the parameter type so
the signature now fits within the width limit; re-format to match.
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 3825099 to 93006aa Compare July 9, 2026 01:18
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from 8cd84f4 to 4bd142b Compare July 9, 2026 01:18
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from 93006aa to fa54bf4 Compare July 9, 2026 01:35
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from 4bd142b to 3a82c38 Compare July 9, 2026 01:35
mfw78 added 2 commits July 9, 2026 01:49
…lock override

Add a clock-reader fixture that reads the WASI wall clock through std on
every event and logs it, plus a harness test that pins a ManualClock,
boots the fixture under that override, dispatches a block, and asserts the
guest logged the pinned instant rather than the ambient host clock. This
proves the WasiClockOverride reaches the guest end to end, not just the
host boot path.
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from fa54bf4 to e1282d9 Compare July 9, 2026 01:53
@mfw78 mfw78 force-pushed the docs/typed-fault-review-nits branch from 3a82c38 to 9f9f513 Compare July 9, 2026 01:53
@mfw78 mfw78 force-pushed the test/guest-clock-e2e branch from e1282d9 to 0adea04 Compare July 9, 2026 07:55
Base automatically changed from test/guest-clock-e2e to develop July 9, 2026 07:57
@mfw78 mfw78 added the pr-train Part of the current stacked PR train; lands in sequence, do not merge out of order. label Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-train Part of the current stacked PR train; lands in sequence, do not merge out of order.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants