docs: fix field name typo for interactive_area_brush example#9813
Merged
docs: fix field name typo for interactive_area_brush example#9813
Conversation
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`.
Member
|
Thanks! Next time, you can make a branch in this fork so that the CI can run fully (the format one). |
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.
PR Description
The
interactive_area_brushentry inexamples.jsonhas"descripton"(missing ani) instead of"description". Becausecreate-example-pageschecksexample.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:
The gallery page currently shows no description text:
Just for future reference,
create-example-pagesfirst checks for adescriptionfield in the example'sexamples.jsonentry. If none is found, it falls back to thedescriptionfield in the.vl.jsonspec file. In this case,examples.jsonhas 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
npm testruns successfullysite/docs/+ examples.Tips: