Remove formatter recommendation section from guide#9434
Open
Conversation
Removed the section on adding a formatter to the marimo repo, which included recommendations for rendering rich displays of objects.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
No issues found across 1 file
Architecture diagram
sequenceDiagram
participant UI as marimo UI (Client)
participant Kernel as marimo Kernel (Server)
participant Object as User-Defined Object
participant Internal as marimo Core Formatters
Note over Object, Internal: Current State: Rendering Flow
UI->>Kernel: Request cell execution
Kernel->>Kernel: Evaluate Python code
Note over Kernel, Object: Protocol Discovery (Preferred Path)
alt Check marimo specific display
Kernel->>Object: call _display_()
else Check IPython compatibility
Kernel->>Object: call _repr_mimebundle_() or _repr_html_()
else Check marimo mime protocol
Kernel->>Object: call _mime_()
end
Object-->>Kernel: Return rich media / HTML
opt If no protocols implemented (Legacy/Built-in Path)
Kernel->>Internal: Lookup type in marimo/_output/formatters
Internal-->>Kernel: Return formatted output
Note right of Internal: CHANGED: Contributions to this<br/>directory are now discouraged.
end
Kernel-->>UI: Send MIME data for rendering
UI->>UI: Render output in notebook
Contributor
There was a problem hiding this comment.
Pull request overview
Removes documentation guidance that suggests contributing new object formatters directly to the marimo repository, aligning the guide with the stated preference that library authors/users create their own viewers/renderers.
Changes:
- Deleted the “Option 4: Add a formatter to the marimo repo” section from the integration guide.
| @@ -143,17 +143,3 @@ def __(): | |||
| ``` | |||
|
|
|||
| /// | |||
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.
Removed the section on adding a formatter to the marimo repo. It's better if folks make their own viewers for their own objects.