Skip to content

Website: fix docs snippet check failing deploys on main - #500

Merged
cpsievert merged 1 commit into
mainfrom
fix/plotly-linked-highlight-snippet
Nov 21, 2026
Merged

cpsievert merged 1 commit into
mainfrom
fix/plotly-linked-highlight-snippet

Conversation

@cpsievert

Copy link
Copy Markdown
Collaborator

Why

The website production deploy has been failing on every push to main since #498 merged: check_docs.py reports website/widgets/plotly/index.md:986: snippet does not match examples/15_linked_highlight.py, which exits the deploy workflow before the site builds. Merging this unblocks deploys again.

What happened

#498 intentionally simplified the bars() renderer in the linked-highlight snippet to plain @render_plotly — it never reads a selection accessor (the reactive effect reads scatter.selected_rows() and mutates bars.widget directly, so the listen_to=["selected"] opt-in is unnecessary there) — but the matching edit to examples/15_linked_highlight.py was missed, leaving the snippet and the example file out of sync.

The fix

One-line change: drop listen_to=["selected"] from bars() in the example file so it matches the prose snippet. Verified locally that website/_tools/check_docs.py now reports nothing.

Note on py-check

The py-check.yaml playwright failures on recent main runs are a separate, flaky issue — a different test fails each run (test_drawn_features_follow_mapbox_draw_and_reset_on_rerender in one, test_native_plotly_events_need_a_trace_callback in another, each 1 failed, ~100 passed). Not addressed here.

The bars() renderer never reads a selection accessor (the reactive
effect reads scatter.selected_rows() and mutates bars.widget), so #498
removed listen_to=["selected"] from the bars() snippet in
widgets/plotly/index.md but missed the matching example file, failing
check_docs.py and the website production deploy on main.
@netlify

netlify Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for shinywidgets canceled.

Name Link
🔨 Latest commit 063ef17
🔍 Latest deploy log https://app.netlify.com/projects/shinywidgets/deploys/6b00df86a66d1152a4ed10cd

@github-actions

Copy link
Copy Markdown

@github-actions
github-actions Bot temporarily deployed to pull request November 21, 2026 00:05 Inactive
@cpsievert
cpsievert merged commit 80176da into main Nov 21, 2026
9 checks passed

This branch was previously deployed

1 inactive deployment
pull request — 063ef17e Deployed Nov 21, 2026 by github-actions[bot]
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.

1 participant