Skip to content

Remove formatter recommendation section from guide #9434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
koaning merged 2 commits into from
May 21, 2026
Merged

Remove formatter recommendation section from guide #9434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68def8a
Remove formatter recommendation section from guide
koaning May 1, 2026
1572702
Clarify object display method implementation steps
koaning May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions docs/guides/integrating_with_marimo/displaying_objects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ three options:
2. Implement a `_mime_()` method
3. Implement an IPython-style `_repr_*_()` method

If you can't modify the object, you can also add a formatter to the marimo library (option 4).

The return value of these methods determines what is shown. `_display_`
has the highest precedence, then built-in formatters, then `_mime_`, then `IPython` style `_repr_*_`
methods.
Expand Down Expand Up @@ -143,17 +141,3 @@ def __():
```

///

@akshayka akshayka May 18, 2026

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?


## Option 4: Add a formatter to the marimo repo

The recommended way to render rich displays of objects in marimo is to
implement `_display_` if possible, otherwise either the IPython `_repr_*_()_`
protocol or marimo's `_mime_()` protocol. If you are a a user of a library that
does not render properly in marimo, consider asking the library maintainers to
implement one of these protocols.

If it is not possible to implement a renderer protocol on the type
you want displayed, we will consider contributions to add formatters to the
marimo codebase. [Look at our codebase for
examples](https://github.com/marimo-team/marimo/tree/main/marimo/_output/formatters),
then open a pull request.
Loading