Brummel
bcd41810f4
Reader-facing prose and rustdoc carried opaque shorthand like
"Decision 10", "clause-5", "mq.1", "ct.1", "eob.1", "rpe.1",
"post-mq.3", and "Iter 22b.1:" with no in-repo definition the reader
could follow. This commit replaces every such occurrence in the
durable tier the reader is most likely to land on (design/ ledger +
source //! module headers + the central /// public-item rustdoc) with
an inline content phrase plus, where applicable, a Markdown link to
the file that defines the referenced concept.
design/ ledger — 16 files:
Definition-site headings demoted from "Decision N: <title>" to
"<title>": authoring-surface, tail-calls, memory-model section in
rc-uniqueness.md, dual-allocator section, typeclass design,
effects "pure core + algebraic effects".
Cross-reference sites: "Decision 1" -> canonical-schema principle
(data-model); "Decision 3/4" -> effects + scope-boundaries; "Decision
6" -> authoring-surface; "Decision 8" -> tail-calls; "Decision 9" ->
rc-uniqueness (dual-allocator); "Decision 10" -> memory-model;
"Decision 11" -> typeclasses (model). "clause-5" -> body-link
durability gate. "clause-3" (in language-constraints) ->
bug-class-reintroduction discriminator. "mq.1/2/3", "ct.1/4",
"eob.1", "rpe.1" -> the canonical-form rule / the type-driven
dispatch / the Str carve-out / etc. "post-mq.3" -> "type-driven".
design/contracts/feature-acceptance.md: file-local "clauses 1/2/3"
-> "criteria 1/2/3" (sprachliche Kohärenz mit der File-Überschrift
"Feature-acceptance criterion"); "the clause-3 mechanism" -> "the
bug-class-reintroduction discriminator".
Source //! module headers — 24 files:
Stripped "Iter X.Y:" prefixes and "(Decision N)" / "(mq.X)" tags
from spec_drift, uniqueness, reuse_shape, migrate_canonical_types,
typeclass_22b{2,3,c}, suppress_filter, lift, mono, linearity,
diagnostic, method_dispatch_pin, method_collision_pin,
no_per_type_print_ops, mq3_multi_class_e2e, print_mono_body_shape,
print_no_leak_pin, cli_diag_human_workspace_load_error,
ct1_check_cli, prose snapshot, unbound_in_instance_method_pin,
mono_xmod_ctor_pattern, desugar.
Central /// public-item rustdoc:
ast.rs (full sweep — every "Iter X" + "Decision N" prefix
reformulated; mode/Type::Fn rustdoc now points at memory-model.md;
Constraint / SuperclassRef / InstanceDef / ClassDef rustdoc points
at typeclasses contract).
diagnostic.rs (all "(Iter X)" / "(mq.X)" tags on diagnostic codes
removed).
lib.rs (FORM_A_SPEC rustdoc points at authoring-surface.md
instead of "Decision 6").
canonical.rs (type_hash + Float-literal rustdoc).
Still outstanding (for a follow-up commit): ~500 inline `//`
code-body comments with `Iter X.Y` markers across the workspace, and
a handful of `///` rustdoc items in hash_pin / workspace_pin / lift /
mono / suppress_filter test-pin and internal-function bodies. Code
identifiers (test filenames like `mq3_multi_class_e2e.rs`, function
names like `iter18e_drop_iterative_default_preserves_hashes`) stay
verbatim per the user's "code identifiers stay verbatim" rule.
Tests: design_index_pin 5/5 + docs_honesty_pin 5/5; workspace builds
clean; full `cargo test --workspace` previously green (every
`test result: ok` line, no FAILED line).
91 lines
4.3 KiB
Markdown
91 lines
4.3 KiB
Markdown
# Form (B) — prose projection whitepaper
|
|
|
|
## Form (B) — human prose projection
|
|
|
|
AILang ships a
|
|
second textual projection of the AST: `ailang-prose`, a one-way
|
|
projection from `Module → human-readable text`. It is **not** an
|
|
authoring surface; it is the "display" projection that the
|
|
[authoring surface](../contracts/authoring-surface.md)'s
|
|
architectural pin explicitly anticipated:
|
|
|
|
> *"Future projections are explicitly anticipated: a visual /
|
|
> graphical front-end is a plausible second projection for human
|
|
> review and inspection (display being the one case where non-AI
|
|
> eyes matter). The architecture leaves room: any producer of
|
|
> well-formed `ailang-core::ast::Module` values is a valid
|
|
> front-end."*
|
|
|
|
Form (B) targets the specific failure mode where a human reviewer
|
|
needs to read an AILang module quickly. Form (A) was designed to
|
|
fit a 30-production EBNF spec and to be parsed zero-shot by foreign
|
|
LLMs; that prioritisation makes it dense and visually noisy for
|
|
human readers. Form (B) inverts the trade-offs:
|
|
|
|
- **Rust-flavoured surface.** Braces and `=>` for match arms,
|
|
Rust-aligned 4-level operator precedence, infix arithmetic
|
|
(`a + b`, not `+(a, b)`), unary `!` for `not`.
|
|
- **Lossy by design.** Projection elides machinery the LLM can
|
|
re-derive: `(con T)` wrappers (`(con Int)` → `Int`), the
|
|
`(fn-type (params ...) (ret ...))` wrap, `(term-ctor T C ...)`
|
|
collapses to `C(...)`, redundant parens. Only the AST machinery
|
|
whose information is recoverable from typecheck context.
|
|
- **Lossless on load-bearing detail.** Mode annotations
|
|
(`own T`, `borrow T`), effects (`with IO`), explicit `clone`,
|
|
`reuse-as`, doc strings, type annotations on signatures and
|
|
lambdas, the `tail` flag — all preserved verbatim.
|
|
|
|
Critically, **form (B) has no parser**. Form (A) is round-trippable
|
|
by construction (see [roundtrip invariant](../contracts/roundtrip-invariant.md));
|
|
form (B) deliberately is not. Re-integrating prose edits requires an
|
|
external LLM mediator, not a compiler pass — the prompt template
|
|
`ail merge-prose` composes the six-step cycle.
|
|
|
|
Form (B) does not weaken any
|
|
[authoring surface](../contracts/authoring-surface.md) invariant:
|
|
|
|
- The [JSON-AST](../contracts/data-model.md) remains the only
|
|
hashable artefact. Prose is not hashed, not content-addressed,
|
|
not load-bearing for any cross-module reference.
|
|
- Form (A) remains the canonical authoring surface. Foreign LLMs
|
|
still author against form (A); humans review and edit through
|
|
form (B).
|
|
- The 30-production grammar of form (A) is unchanged.
|
|
- `ailang-check` and `ailang-codegen` remain projection-agnostic;
|
|
`ailang-prose` is a downstream consumer of `ailang-core::ast`,
|
|
parallel to `ailang-surface` but in the rendering direction only.
|
|
|
|
The CLI gains `ail prose <m.ail.json>` (the deterministic
|
|
projection) and `ail merge-prose <m.ail.json> <edited.prose.txt>`
|
|
(the mediator-prompt composer); both are listed under
|
|
[pipeline](pipeline.md).
|
|
|
|
## Form-A spec embedding
|
|
|
|
An earlier `merge-prose`
|
|
prompt instructed the LLM to emit JSON-AST and offered a 12-line
|
|
schema-essentials reminder; that combination did not give a
|
|
foreign LLM enough to produce valid output. The current prompt revises this:
|
|
|
|
- The LLM emits **Form-A** (the canonical authoring surface), not
|
|
JSON. JSON-AST stays the only hashable artefact, but it is not
|
|
a writing surface. The user runs `ail parse foo.new.ail`
|
|
before `ail check` to produce the canonical JSON.
|
|
- `crates/ailang-core/specs/form_a.md` is the complete LLM-targeted
|
|
Form-A specification — grammar, every term / pattern / type /
|
|
def keyword, schema invariants, pitfall catalogue, four
|
|
few-shot modules drawn from `examples/*.ail`. It is exported
|
|
as `ailang_core::FORM_A_SPEC` and embedded verbatim in every
|
|
`merge-prose` prompt.
|
|
- `crates/ailang-core/tests/spec_drift.rs` walks every variant of
|
|
`Term`, `Pattern`, `Type`, `Def`, `Literal` via exhaustive
|
|
`match` and asserts an anchor for each appears in the spec.
|
|
The exhaustive match is the load-bearing piece: adding a new
|
|
variant without updating the match fails compilation in this
|
|
test, before its assertions even run. Hand-written content,
|
|
mechanical drift detection.
|
|
|
|
The cycle's lowest-common-denominator path is the static prompt
|
|
(`ail merge-prose | client | ail parse | ail check`), which works
|
|
with any client.
|