From 1be2c1f1452ee69ab2815da2ca1c2d1775861c9a Mon Sep 17 00:00:00 2001 From: Brummel Date: Tue, 2 Jun 2026 02:34:40 +0200 Subject: [PATCH] docs: fix doc_lazy_continuation across the workspace Eighteen markdown list items in module- and item-doc comments had continuation lines that were not indented to align under the item text, so rustdoc rendered them as separate paragraphs and broke the list. Corrected the indentation (and, at two sites where a general wrap-up sentence followed a sublist, separated it with a blank doc line so it does not mis-attach to the last item). Doc whitespace only; no prose reworded, no code changed. Workspace clippy is now warning-clean. --- crates/ail/src/main.rs | 1 + crates/ail/tests/cut55_cutover_surface.rs | 4 ++-- crates/ail/tests/embed_e2e.rs | 6 +++--- crates/ailang-check/src/mono.rs | 1 + crates/ailang-codegen/src/intercepts.rs | 14 +++++++------- crates/ailang-core/src/lib.rs | 6 +++--- 6 files changed, 17 insertions(+), 15 deletions(-) diff --git a/crates/ail/src/main.rs b/crates/ail/src/main.rs index 9b6160f..780abf1 100644 --- a/crates/ail/src/main.rs +++ b/crates/ail/src/main.rs @@ -2195,6 +2195,7 @@ fn locate_str_runtime() -> Result { /// 1. the directory containing the running `ail` binary, walked up /// (handles `target/release/ail` and `target/debug/ail`). /// 2. the current working directory, walked up. +/// /// On miss, fails with `err_msg` verbatim — callers pass the /// byte-identical message their flag expects. fn locate_runtime_file(filename: &str, err_msg: &str) -> Result { diff --git a/crates/ail/tests/cut55_cutover_surface.rs b/crates/ail/tests/cut55_cutover_surface.rs index ce1f742..e3db4cb 100644 --- a/crates/ail/tests/cut55_cutover_surface.rs +++ b/crates/ail/tests/cut55_cutover_surface.rs @@ -15,8 +15,8 @@ //! * borrow over value type -> `borrow-over-value` (signature), //! * borrowed return -> `borrow-return-not-permitted` (sig), //! * consume while borrowed -> `consume-while-borrowed` (linearity), -//! and emit the `over-strict-mode` advisory (a warning, exit 0) on a -//! true read-only `(own)` heap param. +//! and emit the `over-strict-mode` advisory (a warning, exit 0) on a +//! true read-only `(own)` heap param. //! //! Coupling discipline: the assertions key on the bracketed diagnostic //! CODE (e.g. `[consume-while-borrowed]`) appearing in stderr, never on diff --git a/crates/ail/tests/embed_e2e.rs b/crates/ail/tests/embed_e2e.rs index eee07d2..20d9241 100644 --- a/crates/ail/tests/embed_e2e.rs +++ b/crates/ail/tests/embed_e2e.rs @@ -1,8 +1,8 @@ //! Embedding-ABI M1 coherent-stop proof (spec §"Testing strategy" 5 //! + Acceptance criteria): build `examples/embed_backtest_step.ail` -//! as a staticlib, link the C host against `libembed_backtest_step.a` -//! + `libailang_rt.a`, run it, assert the `s == 25` assertion holds -//! (exit 0). This is the whole-milestone existence proof. +//! as a staticlib, link the C host against `libembed_backtest_step.a` +//! + `libailang_rt.a`, run it, assert the `s == 25` assertion holds +//! (exit 0). This is the whole-milestone existence proof. use ailang_test_support::workspace_root; use std::path::PathBuf; diff --git a/crates/ailang-check/src/mono.rs b/crates/ailang-check/src/mono.rs index 45e15ab..e98f99e 100644 --- a/crates/ailang-check/src/mono.rs +++ b/crates/ailang-check/src/mono.rs @@ -30,6 +30,7 @@ //! a fully-concrete substitution; the source body is taken //! directly and rigid-var-substituted into a //! `__…` fn. +//! //! The loop re-walks bodies added by the previous round, which is //! what closes it over chained class-method calls (e.g. //! `Eq.ne x y = not (eq x y)`). Targets are deduplicated within a diff --git a/crates/ailang-codegen/src/intercepts.rs b/crates/ailang-codegen/src/intercepts.rs index 191303f..46a7c7a 100644 --- a/crates/ailang-codegen/src/intercepts.rs +++ b/crates/ailang-codegen/src/intercepts.rs @@ -8,14 +8,14 @@ //! - `expected_params` — LLVM-IR param types as text //! - `expected_ret` — LLVM-IR return type as text //! - `wants_alwaysinline` — whether the dispatch site should -//! attach the `alwaysinline` attribute -//! to the emitted fn (was a separate -//! hardcoded name-list in the predicate -//! `intercept_emit_wants_alwaysinline` -//! before raw-buf.1) +//! attach the `alwaysinline` attribute +//! to the emitted fn (was a separate +//! hardcoded name-list in the predicate +//! `intercept_emit_wants_alwaysinline` +//! before raw-buf.1) //! - `emit` — the per-arm IR-emission body, run -//! against `&mut Emitter` after the -//! sig check +//! against `&mut Emitter` after the +//! sig check //! //! Adding a new intercept = adding one row to `INTERCEPTS`. The //! dispatch site (`try_emit_primitive_instance_body` in diff --git a/crates/ailang-core/src/lib.rs b/crates/ailang-core/src/lib.rs index 346ae94..09cbb84 100644 --- a/crates/ailang-core/src/lib.rs +++ b/crates/ailang-core/src/lib.rs @@ -124,9 +124,9 @@ pub const FORM_A_SPEC: &str = include_str!("../specs/form_a.md"); /// /// This is the lowest-level entry point and does **not** resolve imports /// — for the transitive closure use `ailang_surface::load_workspace` -/// (which composes [`workspace::load_modules_with`] + a prelude inject -/// + [`workspace::build_workspace`]). Errors are returned as -/// [`Error::Io`] / [`Error::Json`] / [`Error::SchemaMismatch`]. +/// (which composes [`workspace::load_modules_with`] + a prelude inject +/// + [`workspace::build_workspace`]). Errors are returned as +/// [`Error::Io`] / [`Error::Json`] / [`Error::SchemaMismatch`]. pub fn load_module(path: &std::path::Path) -> Result { let bytes = std::fs::read(path)?; let module: Module = serde_json::from_slice(&bytes)?;