docs(v3): sync scalar-domain guide with implementation; drop deleted-Python refs#264
Merged
Conversation
…Python refs Cross-checked docs/reference/adding-a-scalar-encrypted-domain-type.md against the current eql-scalars / eql-codegen / sqlx harness and corrected stale claims: - Matrix macros: the two wrappers ordered_numeric_matrix! / eq_only_scalar_matrix! were unified into scalar_matrix! (caps = [eq] / [eq, ord] over scalar_domain_matrix!). - Term::returns is not a real method; the methods are json_key/extractor/ctor/ role/operators/requires (the Returns column is eql_v3. + ctor). - Schema const is SCHEMA, not CORE_SCHEMA. - Temporal impls are emitted by the temporal_values! declarative macro, not hand-written. Also removed every dangling reference to the deleted Python codegen toolchain (tasks/codegen/*.py, terms.py, templates.py, operator_surface.py, *.toml type manifests, load_spec) across eql-scalars, eql-codegen, and the jsonb operator surface guard test, re-pointing them at the Rust sources of truth. The CHANGELOG [Unreleased] entry that documents the removal is left intact.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
tobyhede
added a commit
that referenced
this pull request
Jun 9, 2026
…guide Post-rebase verification of the implementation against the updated guide (docs/reference/adding-a-scalar-encrypted-domain-type.md) surfaced two documentation-only drifts: - §7 still described text/date dispatch via a `[text]`/`[temporal]` harness marker. Dispatch is catalog-derived (ScalarKind) — the markers were removed in the macro reduction. Reworded to match. - §1 TL;DR said "seven small registrations" while §3 (correctly) says "two" (the single scalar_types! line + the EqlPlaintext impl). Pre-existing in origin/eql_v3 #264; aligned to two. No implementation changes — the audit found zero code defects.
tobyhede
added a commit
that referenced
this pull request
Jun 20, 2026
docs(v3): sync scalar-domain guide with implementation; drop deleted-Python refs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two subagents cross-checked
docs/reference/adding-a-scalar-encrypted-domain-type.mdagainst the currenteql-scalars/eql-codegen/ SQLx harness implementation. This PR fixes the stale claims they found, then removes every dangling reference to the deleted Python codegen toolchain across the codebase.Guide corrections
ordered_numeric_matrix!/eq_only_scalar_matrix!no longer exist — they were merged into a singlescalar_matrix!wrapper selected by acaps = [eq]/caps = [eq, ord]marker (over the low-levelscalar_domain_matrix!). Updated in §3 and §4.Term::returnsis fictional. The realTermmethods arejson_key/extractor/ctor/role/operators/requires; the "Returns" column iseql_v3.+ctor.SCHEMA, notCORE_SCHEMA(crates/eql-codegen/src/consts.rs).temporal_values!declarative macro inscalar_domains.rs, not hand-written.Deleted-Python cleanup
Removed/redirected every reference to the removed
tasks/codegen/Python system (terms.py,templates.py,operator_surface.py,test_operator_surface.py,generate.py,writer.py, thetypes/*.tomlmanifests,load_spec,TERM_CATALOG):crates/eql-scalars/src/lib.rs— module header, 6 ×Mirrors terms.py::…lines, 2 ×verbatim from …tomlprovenance lines.crates/eql-codegen/src/{generate,writer,operator_surface}.rs,consts.rs—(port of *.py)headers.tests/sqlx/tests/encrypted_domain/family/jsonb_operator_surface.rs— "source of truth" comments + assert message re-pointed tocrates/eql-codegen/src/operator_surface.rs(OPERATORS).load_specreference reworded.Intentionally left as-is: the
CHANGELOG.md[Unreleased]entry that documents the Python removal (correct past-tense reference), and a coincidental.py}byte sequence inside an encrypted ciphertext blob inmigrations/005_*.sql.Verification
cargo check -p eql-scalars -p eql-codegenpasses (exit 0).Summary by CodeRabbit
New Features
Documentation
Tests