Skip to content

Update publisher filter syntax in notebook docs#309

Open
jswir wants to merge 2 commits intomalloydata:mainfrom
jswir:docs/publisher-filter-syntax
Open

Update publisher filter syntax in notebook docs#309
jswir wants to merge 2 commits intomalloydata:mainfrom
jswir:docs/publisher-filter-syntax

Conversation

@jswir
Copy link
Copy Markdown
Contributor

@jswir jswir commented Apr 21, 2026

Summary

  • Publisher's filter annotation syntax changed from JSON-style (#(filter) {\"type\": \"Star\"} on dimensions + a ##(filters) notebook annotation) to source-level declarations with name=/dimension=/type= parameters. Notebooks now inherit filters automatically from imported sources — no notebook-level config needed.
  • Rewrites the "Interactive Filters" section of src/documentation/user_guides/notebooks.malloynb to match the spec at malloydata/publisher/docs/filters.md.
  • New filter types documented: equal, in, like, greater_than, less_than. Adds the implicit/required flags and the multi-filter-per-dimension pattern (used for date ranges).
  • Drops the Carrier Analysis example link (that source hasn't been migrated to the new syntax); keeps the Auto Recalls link, which has.

Test plan

  • Render the page locally and confirm tables/code blocks display correctly
  • Click through to the Auto Recalls example and confirm the linked source uses the new syntax
  • Spot-check that no other doc pages still reference the old {"type": "Star"} / ##(filters) syntax

jswir added 2 commits April 21, 2026 16:59
Publisher's filter annotation syntax changed from JSON-style
(`#(filter) {"type": "Star"}` on dimensions plus a `##(filters)`
notebook annotation) to source-level declarations with name=/dimension=/type=
parameters. Notebooks now inherit filters automatically from imported
sources—no notebook-level configuration needed.

Updates notebooks.malloynb to match the spec at
malloydata/publisher/docs/filters.md, including the new filter types
(equal/in/like/greater_than/less_than), the implicit/required flags,
and the multiple-filters-per-dimension pattern for date ranges.
I, James Swirhun <james@credibledata.com>, hereby add my Signed-off-by to this commit: ccff94b

Signed-off-by: James Swirhun <james@credibledata.com>
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.

2 participants