The documentation for _repr_pretty_ at the end of the Rich Display section is confusing. It was never clear to me that this particular method was applicable in a different context than the _ipython_display_ and other _repr_* methods.
Though the paragraph starts with
To customize how the REPL pretty-prints your object[...]
the the notebook/QTConsole-specific methods use the same naming convention, and the entire rest of the section is dedicated non-REPL usage.
I would like to update the documentation to make the distinction clearer. Here are a couple possible improvements:
- Create separate sub-sections for REPL and non-REPL display methods;
- Put
_repr_pretty_ first, and reword the next section to say that the other methods are available in addition to _repr_pretty_ when using IPython outside of the REPL.
Would it be possible to backport this change to other versions as well?
The documentation for
_repr_pretty_at the end of the Rich Display section is confusing. It was never clear to me that this particular method was applicable in a different context than the_ipython_display_and other_repr_*methods.Though the paragraph starts with
the the notebook/QTConsole-specific methods use the same naming convention, and the entire rest of the section is dedicated non-REPL usage.
I would like to update the documentation to make the distinction clearer. Here are a couple possible improvements:
_repr_pretty_first, and reword the next section to say that the other methods are available in addition to_repr_pretty_when using IPython outside of the REPL.Would it be possible to backport this change to other versions as well?