doc: show pn.state.sync_busy in the busy how-to - #8564
Merged
Conversation
The busy how-to only walked through the manual `pn.bind` pattern. Add a second section demonstrating `pn.state.sync_busy(indicator)`, the higher-level API that keeps a `BooleanIndicator` (e.g. `BooleanStatus`, `LoadingSpinner`) in step with `pn.state.busy` without writing the binding yourself. Closes holoviz#2334.
philippjfr
approved these changes
Apr 23, 2026
philippjfr
left a comment
philippjfr
left a comment
Member
There was a problem hiding this comment.
Much appreciated @mvanhorn!
Contributor
Author
|
Thanks for the doc merge, @philippjfr. Showing sync_busy in context helps a lot. |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Closes #2334.
The busy how-to (
doc/how_to/state/busy.md) only showed the manualpn.bind(indicator, pn.state.param.busy)pattern.pn.state.sync_busyhas been onstate.pyfor years and is listed indoc/api/state.md, but a user reading the busy how-to or the indicator gallery has no reason to discover it.This adds a short second section to the how-to that demonstrates the direct API:
Verified
sync_busysignature inpanel/io/state.py:1021and confirmed the referenced indicator classes (BooleanStatus,LoadingSpinner) and theirBooleanIndicatorbase still exist inpanel/widgets/indicators.py.