docs(contracts): reconcile contracts + honesty-pin with shipped reality
First tranche of a contracts-against-code audit (the inverse of the
usual direction: testing the ledger's claims against the code). Each
fix here is a verified factual divergence between a contract and the
code; the direction of the fix follows which side actually drifted.
Code drifted from the stated goal -> fix the code:
- 0014's claim 6 ("`cargo doc --no-deps` runs warning-free") was the
design goal; reality had 6 warnings. Demote the offending intra-doc
links to plain code spans so the docs match the goal:
- ailang-core: `[`load_workspace`]` cannot resolve from core (the
fn lives in ailang-surface, which core may not depend on) — three
sites in workspace.rs.
- ailang-check: three public-item docs linked the `pub(crate)`
helpers `qualify_local_types` / `qualify_workspace_types`.
`cargo doc --no-deps --workspace` is now warning-free.
Contract stale, code legitimately advanced -> fix the contract:
- 0011 stated `float_to_str` "codegen is reserved and not yet
shipped". It is shipped: lowers to `@ailang_float_to_str(double)`,
green under the codegen `float_to_str_no_longer_errors_internal`
unit test and the e2e `float_to_str_smoke`. The docs_honesty_pin
anchor that protected the stale "reserved" wording moved in lockstep
to assert the present-tense lowering instead — the pin had been
guarding a claim the code already falsified.
- 0013 named the diagnostic `ConstraintReferencesUnboundTypeVar`; the
variant is `UnboundConstraintTypeVar` (workspace.rs), and its scope
is a class-method signature whose constraint mentions a tyvar bound
neither by the method's `forall` nor by the class `param`.
- 0017 called the primitive Eq/Ord bodies "placeholder lambdas"; they
carry the `(intrinsic)` marker — the lockstep partner to the
INTERCEPTS registry, not a placeholder.
- 0009 said "seven" `.ail.json` carve-outs and described the inventory
test as pinning seven; the test pins twelve (7 subject-matter + 4
recur + 1 loop-binder, per carve_out_inventory.rs).
Verified separately: 0001's "pretty-printer code in pretty.rs was
deleted, leaving only diagnostic helpers" is factually correct (an
audit agent misread it as "pretty.rs was deleted"); its only issue is
history phrasing, deferred to the honesty-prose tranche.
Deferred to later tranches: honesty-rule prose (history/rationale that
is not a protected honest-reserved/tiebreaker anchor), stale/mislinked
ratifying-tests (0014's `architect_sweeps.sh`, 0015's uniqueness
in-source tests), 0014's never-existent `tests/expected/`, 0012's
non-exhaustive tail-context list, and the 0016<->0013 redundancy.
This commit is contained in:
@@ -41,12 +41,12 @@ use std::path::{Path, PathBuf};
|
||||
/// in; all imports are resolved relative to it.
|
||||
///
|
||||
/// `registry` is the workspace-global
|
||||
/// instance registry, built at the end of [`load_workspace`] after the
|
||||
/// instance registry, built at the end of `load_workspace` after the
|
||||
/// DFS over imports completes. It is empty for any workspace whose
|
||||
/// modules contain no [`crate::ast::Def::Instance`] defs.
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct Workspace {
|
||||
/// Name of the entry module (the one passed to [`load_workspace`]).
|
||||
/// Name of the entry module (the one passed to `load_workspace`).
|
||||
pub entry: String,
|
||||
/// Every module reachable from `entry`, indexed by module name.
|
||||
/// `BTreeMap` is used so iteration order is deterministic, which
|
||||
@@ -61,7 +61,7 @@ pub struct Workspace {
|
||||
|
||||
/// workspace-global instance registry (the typeclass design).
|
||||
///
|
||||
/// Built at the end of [`load_workspace`] after all modules are
|
||||
/// Built at the end of `load_workspace` after all modules are
|
||||
/// loaded. Keyed by `(class-name, canonical-type-hash)`; values are
|
||||
/// the matching [`crate::ast::InstanceDef`] plus the name of the
|
||||
/// module it was declared in. The hash key uses
|
||||
|
||||
@@ -120,8 +120,8 @@ fn design_md_present_tense_anchors_present() {
|
||||
assert!(memory.contains("a tiebreaker, not a rationale"),
|
||||
"the self-labelled tiebreaker is honest and stays in memory-model.md (do not over-strip)");
|
||||
// corrected present-tense anchors
|
||||
assert!(str_abi.contains("type-installed; codegen is reserved and not yet shipped"),
|
||||
"float_to_str must be present-tense honest-reserved in str-abi.md");
|
||||
assert!(str_abi.contains("Lowers to `call ptr @ailang_float_to_str(double)`"),
|
||||
"float_to_str is shipped — str-abi.md must state its lowering present-tense, not as reserved");
|
||||
assert!(prelude_classes.contains("`io/print_str` is the only built-in direct-output effect-op"),
|
||||
"the print-op set must be stated present-tense in prelude-classes.md (post-split home), not as a retirement narrative");
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user