Repository navigation
Conversation
…let; fix stale reactable module docstring
selected()/brushed() became state accessors on the parent branch (they attach at render and seed the current selection), so the warm-up idiom now applies only to clicked()/selecting()/brushing()/relayout().
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block these documentation-only changes.
No open issues 🎉
What changed in this PR
This documentation-only PR explains how to capture early interactions with lazy event accessors and updates the reactable bridge description to reflect eager state-accessor attachment.
Changes:
- Adds startup warm-up examples for ipyleaflet’s
clicked()and Plotly’s still-lazy event accessors. - Clarifies that Plotly’s
selected()andbrushed()attach at render and need no warm-up. - Corrects the reactable docstring to describe its shared subscription and per-accessor state slices.
| File | Description |
|---|---|
shinywidgets/_render_widget.py |
Documents warm-up patterns for lazy ipyleaflet and Plotly event accessors. |
shinywidgets/_reactable.py |
Updates the bridge docstring to describe eager attachment and subscription sharing. |
Review effort: Balanced
…to docs-accessor-warmup
cpsievert
marked this pull request as ready for review
November 4, 2026 19:26
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.
Stacked on the plotly selection-state PR (which makes
selected()/brushed()state accessors; this PR'srender_plotlynote is scoped accordingly).Summary
render_plotlydocstring: warm-up note + minimal@reactive.effectsnippet, scoped to the accessors that still attach on first read (clicked(),selecting(),brushing(),relayout()).selected()/brushed()attach at render and don't need it.render_ipyleafletdocstring: same note forclicked()(also servesrender_leafmap's ipyleaflet backend).shinywidgets/_reactable.pymodule docstring: no longer claims "nothing is subscribed and no traffic flows until an accessor is read" — with feat: state-kind accessors attach eagerly at render by default #412, state-kind accessors attach at render. It now describes reality: the bridge binds once per model at render with one sharedonStateChangesubscription, and each accessor emits only itskeyslice.Audit (done on this branch): no renderer docstring mentioned lazy attach before; the repo has no shinychat/querychat/chatlas examples; the only example reading an event accessor (
examples/mols2grid) is safe (clickediseager=True). Renderers still missing the note, for possible follow-up: bokeh (recommended next), matplotlib, ipydatagrid, lonboard, ipyaladin, niivue.Verification
make check: ruff ✓ pyright ✓ unit suite green (the onetest_geolibrefailure is pre-existing on this base and already fixed on main by feat(geolibre): use geolibre's async command methods when available #360).