Document AppMeta and make it public
#6939
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
mscolnick
reviewed
Oct 27, 2025
docs/api/app.md
Outdated
|
|
||
| ::: marimo.app_meta | ||
|
|
||
| ::: marimo._runtime.app_meta.AppMeta |
There was a problem hiding this comment.
we don't normally document private classes, but since this is the return type of a public function, we should likely make this class public as well
There was a problem hiding this comment.
this is what is looks like
akshayka
previously approved these changes
Oct 27, 2025
|
@akshayka I want to make this public before merging. As @mscolnick points out, it's ugly to document something from a hidden module. |
|
@mscolnick much better now, assuming we're cool with making it public like this. 
|
|
you will need to run |
|
@mscolnick should be all good now. |
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 PR was made apon reflecting this message on Discord.
The user in this case was trying to figure out whether or not there was a present mode whenever you access the app meta information. The documentation doesn't actually confirm if this is the case. It doesn't list all the values that the run mode can represent.
Hence, I figured adding the
AppMetaclass to our documentation. That way a user could at least confirm themselves if it is/not supported.