docs(ui): clarify UIElement value is read-only#9382
Draft
onthebed wants to merge 1 commit intomarimo-team:mainfrom
Draft
docs(ui): clarify UIElement value is read-only#9382onthebed wants to merge 1 commit intomarimo-team:mainfrom
onthebed wants to merge 1 commit intomarimo-team:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
All contributors have signed the CLA ✍️ ✅ |
Author
|
I'll get the CLA signed — will follow up once it's done. |
1 similar comment
Author
|
I'll get the CLA signed — will follow up once it's done. |
Author
|
I have read the CLA Document and I hereby sign the CLA |
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.
This pull request was authored by a coding agent.
The shared
UIElementdocs describedvaluewithout noting that it is read-only, even though the runtime rejects direct assignment with aRuntimeErrorand points users tomo.state().This updates the
UIElementclass and property docstrings to say thatvaluereflects frontend state, cannot be assigned directly, and thatmo.state()is the supported way to imperatively drive UI state.Verification:
x.value = "hello"raisesRuntimeError: Setting the value of a UIElement is not allowed...)mkdocs build --strict -q, but the local docs toolchain failed before rendering due to a mkdocstrings/mkdocs config mismatch in this ad-hoc environment (PythonConfig.__init__() got an unexpected keyword argument 'import')Fixes #9203