Skip to content

docs(olai-delta-df): trim AI/session-artifact comment cruft - #132

Merged
roeap merged 1 commit into
mainfrom
cleanup-olai-delta-df-comments
Jul 18, 2026
Merged

roeap merged 1 commit into
mainfrom
cleanup-olai-delta-df-comments

Conversation

@roeap

@roeap roeap commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Summary

The olai-delta-df crate accumulated a lot of comment cruft over successive sessions — the telltale signs of AI-written/session-artifact comments. This sweep cleans the whole crate (all of src/ and tests/) back to comments that a reviewer or future developer actually needs.

Removed:

  • Planning/handover-doc & milestone labels — handover-*.md references, M0–M3 "verification" prefixes, Stage 4/Stage 5/Stage-3 labels, "narrow waist".
  • Porting/POC history — "Ported from the kernel POC", "Unlike the POC", "the POC's X", "replaces the eager InlineExecutor/PrimedStore", "Reconciled to DataFusion 54.0.0". The code is now described as it is, not how it got here.
  • Internal issue/PR references & filler — mangrove#28/#116/#123, "belt-and-suspenders", "not required today", meta-notes about prior comments ("an earlier comment referenced X that never existed").
  • Duplication — comments that restated an adjacent doc comment verbatim (e.g. the block_on caveat repeated three times in snapshot_build.rs).

Preserved every genuine why: the per-row deletion-vector guard, the wasm block_on/getrandom constraints, the leaf-expression-pushdown workaround (apache/datafusion#20432 — a real external pointer, kept), the partition-column metadata strip, and the kernel-API quirks.

Test plan

  • Comment-only change — no code touched.
  • cargo fmt -p olai-delta-df --check clean.
  • cargo check -p olai-delta-df --all-features passes.
  • cargo doc -p olai-delta-df --no-deps builds (pre-existing private-item link warnings only; no new links introduced).

This pull request was AI-assisted by Isaac.

@roeap
roeap marked this pull request as ready for review July 18, 2026 08:17
Sweep the whole crate for comments that only made sense to someone who
read an ephemeral planning doc, and cut them back to what a reviewer or
future developer actually needs:

- Drop planning/handover-doc and milestone labels (M0-M3, "Stage 4/5",
  "narrow waist", handover-*.md references).
- Drop porting/POC history ("Ported from the kernel POC", "Unlike the
  POC", "replaces the eager InlineExecutor/PrimedStore", "reconciled to
  DataFusion 54") — describe the code as it is, not how it got here.
- Drop internal issue/PR references (mangrove#28/#116/#123) and
  "belt-and-suspenders" / "not required today" filler; keep the
  load-bearing external pointer (apache/datafusion#20432).
- De-duplicate comments that restated an adjacent doc comment verbatim.

Preserved every genuine "why": the per-row deletion-vector guard, the
wasm block_on/getrandom constraints, the leaf-pushdown workaround, the
partition-column metadata strip, and the kernel-API quirks. Comment-only
change; `cargo check`/`cargo doc` still pass.

AI-assisted-by: Isaac
@codecov

codecov Bot commented Jul 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@roeap
roeap force-pushed the cleanup-olai-delta-df-comments branch from 8f70511 to 9643ee1 Compare July 18, 2026 08:18
@roeap
roeap merged commit 0c2007b into main Jul 18, 2026
16 checks passed
@roeap
roeap deleted the cleanup-olai-delta-df-comments branch July 18, 2026 08:19
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