Skip to content

docs: show partition_by as a list in the datasets reference example - #2439

Merged
lukekim merged 3 commits into
trunkfrom
lukim/docs-partition-by-list
Oct 27, 2026
Merged

lukekim merged 3 commits into
trunkfrom
lukim/docs-partition-by-list

Conversation

@lukekim

@lukekim lukekim commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

What

The acceleration.partition_by example in the datasets reference shows a scalar, partition_by: block_date. Spice has always parsed partition_by as a list (Vec<PartitionedBy> from v2.0.0 through trunk), so copying the example breaks both spice validate and spiced startup:

ERROR Invalid argument: Invalid: spicepod validation failed: Failed to parse spicepod.yaml: Invalid type string "block_date". Expected a sequence

This PR changes the example to partition_by: [block_date] in the current docs and in the 2.0.x–2.4.x versioned copies. The Partitioning page already uses the list form.

Evidence

All runs use spice/spiced v2.4.0-rc.3.

  • Before: the example as published (partition_by: block_date) fails spice validate with the error above, and spiced exits with the same error.
  • After: the example as changed here passes:
OK docs_example
  components: catalogs=0, datasets=1, ...
  • Runtime check: a Cayenne mode: file dataset with partition_by: [region] validates and spiced starts. With partition_by: region it does not.

Adversarial review (Codex, adversarial-review --base origin/trunk)

  • 04b41ecf: approve, no material findings. Codex did not check older versions itself; partition_by is Vec<PartitionedBy> in spiceai/spiceai at v2.0.0, v2.1.0, v2.2.0, v2.3.0 and trunk, so the list form is correct for every versioned copy.

@lukekim
lukekim requested a review from a team as a code owner October 27, 2026 02:39
Copilot AI balanced review requested due to automatic review settings October 27, 2026 02:39
@cursor

cursor Bot commented Oct 27, 2026

Copy link
Copy Markdown

Bugbot is paused — on-demand spend limit reached

Bugbot uses usage-based billing for this team and has hit its on-demand spend limit.

A team admin can raise the spend limit in the Cursor dashboard, or wait for the next billing cycle to continue.

@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: lukekim, spiceemma

Copilot AI previously approved these changes Oct 27, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved

All six edits consistently correct the YAML value type, with no unresolved issues.

No open issues 🎉

What changed in this PR

This PR corrects the datasets reference example to use the list format expected by acceleration.partition_by, preventing the documented scalar-type parsing error.

Changes:

  • Replaces partition_by: block_date with partition_by: [block_date].
  • Applies the correction to current documentation and versions 2.0.x–2.4.x without changing surrounding configuration.
File Description
website/​versioned_docs/​version-2.4.x/​reference/​spicepod/​datasets.md Corrects the 2.4.x partitioning example.
website/​versioned_docs/​version-2.3.x/​reference/​spicepod/​datasets.md Corrects the 2.3.x partitioning example.
website/​versioned_docs/​version-2.2.x/​reference/​spicepod/​datasets.md Corrects the 2.2.x partitioning example.
website/​versioned_docs/​version-2.1.x/​reference/​spicepod/​datasets.md Corrects the 2.1.x partitioning example.
website/​versioned_docs/​version-2.0.x/​reference/​spicepod/​datasets.md Corrects the 2.0.x partitioning example.
website/​docs/​reference/​spicepod/​datasets.md Corrects the current partitioning example.

Review effort: Balanced

@github-actions

Copy link
Copy Markdown
Contributor

🚀 deployed to https://80ff5dc4.spiceai-org-website.pages.dev

@lukekim lukekim self-assigned this Oct 27, 2026
Copilot AI balanced review requested due to automatic review settings October 27, 2026 16:57
Copilot AI dismissed their stale review, a newer Copilot review was requested October 27, 2026 16:57
Copilot AI previously approved these changes Oct 27, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved

All six edits consistently correct the configuration syntax, with no unresolved issues.

No open issues 🎉

Review effort: Balanced

@github-actions

Copy link
Copy Markdown
Contributor

🚀 deployed to https://fae4c4dd.spiceai-org-website.pages.dev

Copilot AI balanced review requested due to automatic review settings October 27, 2026 19:04
Copilot AI dismissed their stale review, a newer Copilot review was requested October 27, 2026 19:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved

All six edits consistently correct the documented YAML value type, with no unresolved issues.

No open issues 🎉

Review effort: Balanced

@github-actions

Copy link
Copy Markdown
Contributor

🚀 deployed to https://31b58b01.spiceai-org-website.pages.dev

@lukekim
lukekim merged commit 9b255e0 into trunk Oct 27, 2026
8 of 9 checks passed
@lukekim
lukekim deleted the lukim/docs-partition-by-list branch October 27, 2026 20:00

This branch was successfully deployed

1 active deployment
preview — 25d50ae5 Deployed Oct 27, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants