From 5b793f27f86da359c8ba201f3b239ffa74da9cf9 Mon Sep 17 00:00:00 2001 From: "Aaron D. Lee" Date: Sun, 5 Jul 2026 03:36:48 -0400 Subject: [PATCH] docs(sim): rustdoc backtick-fix for angle-bracketed type names + URL linkify MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Three rustdoc warnings (cargo doc --no-deps) in slice-4-half modules: - latency.rs:55 ('Vec' in a heading) — rustdoc parses as an HTML tag start. - scenario.rs:32 (URL with embedded space) — malformed; replaced with the canonical serde.rs URL. - tick_lag.rs:32 ('Mutex>' in a heading) — same HTML tag-parse issue. All three fixed by wrapping type expressions in backticks (the rustdoc convention for inline code) and using a properly-linkified bare URL. No source semantics changed. Signed-off-by: Aaron D. Lee --- crates/rutster-sim/src/latency.rs | 2 +- crates/rutster-sim/src/scenario.rs | 2 +- crates/rutster-sim/src/tick_lag.rs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/rutster-sim/src/latency.rs b/crates/rutster-sim/src/latency.rs index ec40bf3..cc3c01e 100644 --- a/crates/rutster-sim/src/latency.rs +++ b/crates/rutster-sim/src/latency.rs @@ -52,7 +52,7 @@ use crate::sim_audio_pipe::Capture; /// # } /// ``` /// -/// # Why this is a struct (not free fns on Vec) +/// # Why this is a struct (not free fns on `Vec`) /// /// The struct holds the captures by value (one allocation per run, post /// the hot path). Free fns would require either passing `&[Capture]` diff --git a/crates/rutster-sim/src/scenario.rs b/crates/rutster-sim/src/scenario.rs index b7e8568..592ec32 100644 --- a/crates/rutster-sim/src/scenario.rs +++ b/crates/rutster-sim/src/scenario.rs @@ -29,7 +29,7 @@ //! shape for "list of named, differently-shaped records" in TOML — the //! alternative (externally-tagged) would require a redundant table layer //! (`[[steps]] variant = { speak_loud = { frames = 20 } }`) that hurts -//! readability for no benefit. See . +//! readability for no benefit. See //! //! `rename_all = "snake_case"` maps the Rust `SpeakLoud` variant to the //! TOML `speak_loud` tag — matches the convention used in slice-4's diff --git a/crates/rutster-sim/src/tick_lag.rs b/crates/rutster-sim/src/tick_lag.rs index cf38bf0..80aea91 100644 --- a/crates/rutster-sim/src/tick_lag.rs +++ b/crates/rutster-sim/src/tick_lag.rs @@ -29,7 +29,7 @@ //! `MediaThread` registration (the RegisterSim variant forbidden this //! slice) OR a client-server sim mode (deferred per spec §8.6). //! -//! # Hot-path design: atomics (not Mutex>) +//! # Hot-path design: atomics (not `Mutex>`) //! //! Per-tick recording is 3 atomic ops: //! 1. CAS loop on `max_tick_lag_micros` (atomic max update).