Skip to content

Decorator-first docs and demo; fix review nits from #1 - #2

Merged
eddietejeda merged 1 commit into
feat/ci-and-materialize-decoratorfrom
docs/decorator-first
Jul 22, 2026
Merged

Decorator-first docs and demo; fix review nits from #1#2
eddietejeda merged 1 commit into
feat/ci-and-materialize-decoratorfrom
docs/decorator-first

Conversation

@eddietejeda

Copy link
Copy Markdown
Contributor

What

Documentation and demo follow-up to #1 — everything now presents the decorator as the way in:

  • DESIGN.md: the decorator API section separates what shipped (key/ttl/version/background/key_fn) from planned knobs (mode, invalidate_on, index, on_error, from_queryset), so nothing user-facing documents parameters that don't exist. MaterializedFrame section marks the implemented subset; build order ticks step 2.
  • Demo: compare.py exercises @materialize end to end instead of hand-rolling the primitives — the benchmark now tests exactly what the README tells users to write. Verified live: Q1 hit 82 ms (16.3×), parts hit 153 ms (12.8×), perceived miss ≈ direct on both. Decimals round-trip natively now (previously normalized to floats).
  • Both review nits from CI workflow + @materialize decorator #1 addressed: frame.sql() no longer rewrites this inside quoted string literals/identifiers (with a regression test), and the miss-frame .sql() behavior is documented in the README and docstring.

Tests

68 passing; mypy and flake8 clean.

Stacked on #1 (base branch: feat/ci-and-materialize-decorator).

- DESIGN.md: split the decorator API into implemented (first cut) vs
  planned knobs; mark the MaterializedFrame section's implemented subset;
  tick step 2 in the build order
- demo: compare.py now goes through @materialize end to end (evict/flush
  via get_runtime for benchmark mechanics); Decimals round-trip natively
- README: note that frame.sql() needs a persisted entry
- decorator: frame.sql() no longer rewrites `this` inside quoted SQL
  literals/identifiers (review nit); documented the miss-frame .sql()
  behavior (review nit)
@eddietejeda
eddietejeda merged commit ac5bdf3 into feat/ci-and-materialize-decorator Jul 22, 2026
2 checks passed
eddietejeda added a commit that referenced this pull request Jul 22, 2026
Decorator-first docs and demo; fix review nits (re-land #2)
@eddietejeda
eddietejeda deleted the docs/decorator-first branch July 22, 2026 21:21
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