Skip to content

chore: reconcile stale stubs + docs with the landed code - #99

Merged
zzylol merged 1 commit into
mainfrom
chore/hygiene-stubs-docs
Jul 5, 2026
Merged

zzylol merged 1 commit into
mainfrom
chore/hygiene-stubs-docs

Conversation

@zzylol

@zzylol zzylol commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Hygiene pass from the whole-repo review (no behavior changes; workspace suite + clippy untouched-green). Pairs with the new tracking issue #98 (L3→L4 binding + boundary decision).

Stubs (crates/plan)

crates/e2e

Fix the crate-doc claim that it owns cross-language equivalence tests — it is PromQL-only by design (depends only on the PromQL front end); the cross-language tests live in crates/lower.

Docs

Reconciled against the shipped code (the review found the staleness concentrated in L3/L4 vocabulary):

Doc claim Reality → fix
README L2 row: asap-ir::intent_algebra::relational L2 is asap-l2 (incl. the shared canonicalize pass)
L4 IR named SketchExpr (README, design §6, glossary) Shipped as SummaryExpr/L4Node — naming note at the definition + fixed references; binding pass = #98
design: "AggIntent core is 9" ~40 shipped variants; growth rationale kept ("genuinely-distinct operations"), agg_intent.rs named source of truth
design ×3: "HistogramQuantile removed from L3" Revised to the landed two-lowering design (#43/#79): classic-bucket → AggIntent::HistogramQuantile (not re-sketchable), native/raw → generic Quantile; intent, not node
design: Source has Join/time/labels/columns Matched to the shipped thin form; Source::Join marked unimplemented-draft
design: QueryExpr sketch Annotated with shipped additions (Scalar/EvalTime/bridges/Relabel/Sample/InfoJoin/TimeRange)
design §11 workspace members crates/l2 was missing
promql-lowering.md Dead paths fixed (front end → crates/frontend-promql, binder/resolution → crates/l2); convert_root snippet now shows the canonicalize step; moved test path
intent-algebra-reconciliation.md Post-reorg banner: crates/core → ir/l2/plan map; the "CP has 11 intents ASAP lacks" table marked historical (absorbed by #43–#51)

The §5.2 target-layout tree and migration-plan.md keep their original core::<module> names — both already carry explicit reconciliation banners mapping them to the landed split, so they were left as intended.

Hygiene pass from the whole-repo review. No behavior changes — the full
workspace suite and clippy are untouched-green.

Stubs (crates/plan):
- Delete src/canonicalize.rs: its TODO(#34) asked for exactly what already
  shipped — canonicalize() landed in asap-l2 (run inside the shared
  convert_root, cross-language tests in crates/lower/tests) and #34 is closed.
- Re-point src/boundary.rs from the dead TODO(#34) to #98 (the L3→L4 binding +
  sketch-vs-exact boundary tracking issue), spelling out its inputs
  (AccuracyTarget, agg_is_exact/agg_is_mergeable, HistogramKind sketchability).
- lib.rs: note canonicalization lives in asap-l2, drop the deleted module.

crates/e2e: fix the doc claim that it owns cross-language equivalence tests —
it is PromQL-only; the cross-language tests live in crates/lower.

Docs:
- README: L2 row pointed at asap-ir (it is asap-l2, incl. canonicalize);
  SketchExpr → the shipped SummaryExpr/L4Node naming (+ binding pass = #98);
  plan stub list, directory tree, LOC counts, histogram.rs, e2e label.
- design.md: the "AggIntent core is 9" claim updated to the shipped ~40 with
  the growth rationale and agg_intent.rs as source of truth; the three
  "HistogramQuantile was removed from L3" sites revised to the landed
  two-lowering design (#43/#79, intent not node); SketchExpr↔SummaryExpr
  naming note at the §6 definition + glossary; Source enum matched to the
  shipped thin form (no Source::Join); QueryExpr sketch annotated with the
  shipped node additions; workspace-members listing gains crates/l2.
- promql-lowering.md: dead paths (front end is crates/frontend-promql, binder/
  column_resolution are crates/l2), convert_root snippet now shows the
  canonicalize step, moved test path.
- intent-algebra-reconciliation.md: post-reorg banner (crates/core→ir/l2/plan
  map; the CP-intent gap since absorbed by #43-#51 — tables are historical
  evidence), front-end paths.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@zzylol
zzylol merged commit b27e1a0 into main Jul 5, 2026
1 check passed
@zzylol
zzylol deleted the chore/hygiene-stubs-docs branch July 5, 2026 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant