docs(typed-fault): batch the epic #206 review doc nits onto one car#290
Open
mfw78 wants to merge 10 commits into
Open
docs(typed-fault): batch the epic #206 review doc nits onto one car#290mfw78 wants to merge 10 commits into
mfw78 wants to merge 10 commits into
Conversation
d6b095d to
4ba9912
Compare
5340905 to
84542b5
Compare
4ba9912 to
ff47c54
Compare
84542b5 to
711da09
Compare
ff47c54 to
b858d44
Compare
711da09 to
6346d1f
Compare
b858d44 to
a5ff06e
Compare
6346d1f to
5271b4a
Compare
a5ff06e to
c71c52e
Compare
5271b4a to
454c904
Compare
c71c52e to
3a0a374
Compare
454c904 to
4fc6d4a
Compare
3a0a374 to
1baf641
Compare
4fc6d4a to
845029d
Compare
1baf641 to
8c31790
Compare
jean-neiverth
approved these changes
Jul 8, 2026
jean-neiverth
left a comment
Collaborator
There was a problem hiding this comment.
Doc rewrites follow house style. No concerns.
845029d to
df45f97
Compare
e0ad37e to
f4c6f30
Compare
a6ec61a to
8f1affb
Compare
f4c6f30 to
8cd84f4
Compare
8f1affb to
3825099
Compare
… the supervisor rebind
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.
3825099 to
93006aa
Compare
8cd84f4 to
4bd142b
Compare
93006aa to
fa54bf4
Compare
4bd142b to
3a82c38
Compare
…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.
fa54bf4 to
e1282d9
Compare
3a82c38 to
9f9f513
Compare
e1282d9 to
0adea04
Compare
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
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.
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.
host.rs,Fault::RateLimitedrustdoc: say the backoff guidance may be present, matching theOption<u64>field (origin feat(wit-abi): add the fault vocabulary and SDK HostFault surface #213).host.rs,Faultenum rustdoc: drop the restatement of thestrumsnake_case and#[non_exhaustive]attributes, keeping only that#[non_exhaustive]forces a wildcard match arm (origin feat(wit-abi): add the fault vocabulary and SDK HostFault surface #213).host/error.rs,From<StorageError>rustdoc: drop the signature restatement, keep the reason the subsystem tag is omitted (origin feat(host): switch the generic interfaces to fault end to end #215).host/error.rs, thei32::try_fromsaturation comment: a JSON-RPC code outsidei32is a spec violation clamped to-32603, rather than "never seen for real" (origin feat(chain): typed chain-error with an rpc case carrying revert bytes #214).host/error.rs, the transport-level comment: keep only why a guest can tell a revert apart from an unreachable node (origin feat(chain): typed chain-error with an rpc case carrying revert bytes #214).ext_cow.rs,orderbook_error_to_witrustdoc:cowprotocol::Erroris broader than a typed order submission, so map it to WIT form plainly (origin feat(cow-ext): typed cow-api-error owned by the extension package #216).ext_cow.rs,cow_error_to_witrustdoc: tighten "non-2xx orderbook reply" to a transport-layer HTTP failure and point the links at the real generated type rather than the local alias (origin feat(cow-ext): typed cow-api-error owned by the extension package #216).host/impls/chain.rs,request_batchrustdoc: qualify "leaving its neighbours intact" as a property of this impl's independent per-entry fold, not a WIT-level contract (origin fix(runtime): typed-fault train follow-ups #218).cow/error.rs,OrderRejection.datarustdoc: the host serialises an already-parsedValue, so say "serialised to a JSON string viaserde_json::Value::to_string" rather than "re-encodes" (origin fix(runtime): whole-train hardening for the typed-fault stack #219).lib.rsprelude bullet: drop "orderbook" to matchprelude.rs, whose module doc no longer exposes the orderbook surface (origin fix(runtime): whole-train hardening for the typed-fault stack #219).host/error.rs,fault_labelrustdoc: drop the trailing clause that restates the preceding "Mirrors the SDKHostFault::labelvocabulary" (origin feat(host): exports return fault and the host-error envelope dies #217).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> -- --checkon the edited files,cargo clippy -p <crate> --all-targets -- -D warnings, andRUSTDOCFLAGS="-D warnings" cargo doc -p <crate> --no-deps(also--document-private-itemsfor 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.