Brummel d8727d5bdb Iter 13e: rustdoc polish for ailang-check
Second docwriter mission. Pure rustdoc additions (no API or
behaviour change) across the typechecker crate:

- builtins.rs: module root expanded; EffectOpSig (struct + 3
  fields) and install() got /// strings.
- diagnostic.rs: Severity (+ both variants), Diagnostic (+
  severity/code/message fields) and the error/with_def/with_ctx
  helpers got /// strings; super:: link rewritten to crate::.
- lib.rs: CheckError + every variant, to_diagnostic, CheckedModule
  (+ symbols), check, Env (+ globals/effect_ops/types/
  module_globals/current_module), CtorRef (+ type_name) got ///
  strings; crate-root prose upgraded with intra-doc link to
  check_module.

Verification: cargo doc --no-deps zero warnings; cargo build
--workspace green; cargo test --workspace 64/64 + 3 ignored
doctests green. Diff is 188 LOC, all in /// or //! lines (verified
by filtering).

Findings (not fixed; orchestrator-deferred):
- Env is pub but only privately constructable.
- CheckError::CtorArity and ::ArityMismatch share the public
  diagnostic code "arity-mismatch" by design.
- Diagnostic / Severity reachable via two paths because the
  diagnostic module is pub.

JOURNAL.md updated with the Iter 13e entry. 13f (ailang-codegen
+ ail) and 14a (List a rewrite) remain queued.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-07 15:13:03 +02:00
S
Description
No description provided
26 MiB
Languages
Rust 91.6%
Python 4.6%
C 1.8%
LLVM 1.6%
Shell 0.4%