Skip to content

docs: fix field name typo for interactive_area_brush example#9813

Merged
domoritz merged 1 commit intovega:mainfrom
dsmedia:ds/fix-descripton-typo
Apr 7, 2026
Merged

docs: fix field name typo for interactive_area_brush example#9813
domoritz merged 1 commit intovega:mainfrom
dsmedia:ds/fix-descripton-typo

Conversation

@dsmedia
Copy link
Copy Markdown
Contributor

@dsmedia dsmedia commented Apr 7, 2026

PR Description

The interactive_area_brush entry in examples.json has "descripton" (missing an i) instead of "description". Because create-example-pages checks example.description, the misspelled field is silently ignored, and the gallery page renders with no description text.

The entry has a description, but it never renders because of the typo:

In this example, we apply an interval selection to select subset of data in an area chart. The selected data is highlighted in gold by the second layer of an area mark that filters its data by the brush selection.

The gallery page currently shows no description text:

Just for future reference, create-example-pages first checks for a description field in the example's examples.json entry. If none is found, it falls back to the description field in the .vl.json spec file. In this case, examples.json has the description under a misspelled key, and the spec file has no description at all — so neither source provides one.

Found while working on gallery example metadata in vega/vega-datasets#776.

Checklist

  • This PR is atomic (i.e., it fixes one issue at a time).
  • The title is a concise semantic commit message (e.g. "fix: correctly handle undefined properties").
  • npm test runs successfully
  • For new features:
    • Has unit tests.
    • Has documentation under site/docs/ + examples.

Tips:

The `interactive_area_brush` entry in `examples.json` had
`"descripton"` instead of `"description"`, causing the gallery
page to render with no description text. The misspelled field
was silently ignored by `create-example-pages`.
@dsmedia dsmedia requested a review from a team as a code owner April 7, 2026 12:42
@domoritz domoritz merged commit 466f2f6 into vega:main Apr 7, 2026
20 checks passed
@domoritz
Copy link
Copy Markdown
Member

domoritz commented Apr 7, 2026

Thanks! Next time, you can make a branch in this fork so that the CI can run fully (the format one).

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