Repository navigation
Website: fix docs snippet check failing deploys on main - #500
Merged
Merged
Conversation
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.
✅ Deploy Preview for shinywidgets canceled.
|
This branch was previously deployed
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.
Why
The website production deploy has been failing on every push to
mainsince #498 merged:check_docs.pyreportswebsite/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 readsscatter.selected_rows()and mutatesbars.widgetdirectly, so thelisten_to=["selected"]opt-in is unnecessary there) — but the matching edit toexamples/15_linked_highlight.pywas missed, leaving the snippet and the example file out of sync.The fix
One-line change: drop
listen_to=["selected"]frombars()in the example file so it matches the prose snippet. Verified locally thatwebsite/_tools/check_docs.pynow reports nothing.Note on py-check
The
py-check.yamlplaywright failures on recentmainruns are a separate, flaky issue — a different test fails each run (test_drawn_features_follow_mapbox_draw_and_reset_on_rerenderin one,test_native_plotly_events_need_a_trace_callbackin another, each1 failed, ~100 passed). Not addressed here.