Skip to content

docs: clarify _repr_pretty_ plain-text context 🤖🤖 #15406

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

Draft
Marwan-verse wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: clarify _repr_pretty_ plain-text context 🤖🤖 #15406

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions docs/source/config/integrating.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ Special methods
Pretty printing
"""""""""""""""

Unlike the rich display hooks below, ``_repr_pretty_`` customizes plain-text output. It is
supported by the REPL, Notebook, and Qt Console; the table above shows which of the other
``_repr_*_`` hooks each interface supports.

To customize how your object is pretty-printed, add a ``_repr_pretty_`` method
to the class.
The method should accept a pretty printer, and a boolean that indicates whether
Expand All @@ -123,8 +127,8 @@ Here is an example::

For details on how to use the pretty printer, see :py:mod:`IPython.lib.pretty`.

More powerful methods
"""""""""""""""""""""
Rich display methods
""""""""""""""""""""

.. class:: MyObject

Expand Down
Loading