Repository navigation
docs(panel-reactivity-docstring) emphasizing in docstring the non reactivity of mo.ui.panel - #10067
Merged
mscolnick merged 2 commits intoJul 9, 2026
Conversation
…ctivity of mo.ui.panel
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
All contributors have signed the CLA ✍️ ✅ |
for more information, see https://pre-commit.ci
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
mscolnick
approved these changes
Jul 7, 2026
williambdean
pushed a commit
to williambdean/marimo
that referenced
this pull request
Sep 6, 2026
…ctivity of mo.ui.panel (marimo-team#10067) ## 📝 Summary <!-- If this PR closes any issues, list them here by number (e.g., Closes marimo-team#123). Detail the specific changes made in this pull request. Explain the problem addressed and how it was resolved. If applicable, provide before and after comparisons, screenshots, or any relevant details to help reviewers understand the changes easily. --> Closes marimo-team#8296 The docstring for `mo.ui.panel` had a confusing example. It doesn't emphasis that this componentit does not trigger marimo's cross-cell reactivity in other cells. This PR rewrites the docstring example to make that distinction explicit: - The first cell shows Panel-internal reactivity that does update live - The second cell clarifies that reading `.value` gives the current value, but the cell will **not** re-run when the widget changes. - If it would help, I'm willing to add more documentation about mo.ui.panel, like a page in the docs website. ## 📋 Pre-Review Checklist <!-- These checks need to be completed before a PR is reviewed --> - [x] For large changes, or changes that affect the public API: this change was discussed or approved through an issue, on [Discord](https://marimo.io/discord?ref=pr), or the community [discussions](https://github.com/marimo-team/marimo/discussions) (Please provide a link if applicable). - [x] Any AI generated code has been reviewed line-by-line by the human PR author, who stands by it. - [x] Video or media evidence is provided for any visual changes (optional). <!-- PR is more likely to be merged if evidence is provided for changes made --> ## ✅ Merge Checklist - [x] I have read the [contributor guidelines](https://github.com/marimo-team/marimo/blob/main/CONTRIBUTING.md). - [x] Documentation has been updated where applicable, including docstrings for API changes. - [x] Tests have been added for the changes made. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This branch was successfully 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
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.
📝 Summary
Closes #8296
The docstring for
mo.ui.panelhad a confusing example. It doesn't emphasis that this componentit does not trigger marimo's cross-cell reactivity in other cells.This PR rewrites the docstring example to make that distinction explicit:
.valuegives the current value, but the cell will not re-run when the widget changes.📋 Pre-Review Checklist
✅ Merge Checklist