Skip to content

Remove formatter recommendation section from guide#9434

Merged
koaning merged 2 commits into
mainfrom
koaning-patch-3
May 21, 2026
Merged

Remove formatter recommendation section from guide#9434
koaning merged 2 commits into
mainfrom
koaning-patch-3

Conversation

@koaning
Copy link
Copy Markdown
Contributor

@koaning koaning commented May 1, 2026

Removed the section on adding a formatter to the marimo repo. It's better if folks make their own viewers for their own objects.

Removed the section on adding a formatter to the marimo repo, which included recommendations for rendering rich displays of objects.
Copilot AI review requested due to automatic review settings May 1, 2026 16:53
@koaning koaning requested a review from akshayka as a code owner May 1, 2026 16:53
@koaning koaning added the documentation Improvements or additions to documentation label May 1, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
marimo-docs Ready Ready Preview, Comment May 20, 2026 6:24pm

Request Review

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Loading

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 __():
```

///
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@koaning can you address this?

Removed option 4 regarding adding a formatter to the marimo library.
@koaning
Copy link
Copy Markdown
Contributor Author

koaning commented May 20, 2026

@copilot I think it's addressed now?

Copy link
Copy Markdown
Contributor

Copilot AI commented May 20, 2026

@copilot I think it's addressed now?

Yes — this is addressed in 1572702. I rechecked docs/guides/integrating_with_marimo/displaying_objects.md, and the guide now consistently presents only 3 options with no stale “Option 4” references.

@koaning koaning enabled auto-merge (squash) May 20, 2026 19:13
@koaning koaning merged commit 10e3a18 into main May 21, 2026
32 checks passed
@koaning koaning deleted the koaning-patch-3 branch May 21, 2026 17:39
@github-actions
Copy link
Copy Markdown

🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.23.7-dev79

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants