Document the preferred use of show over display (#34438)

One-line addition to documentation to help prevent future questions like this: https://discourse.julialang.org/t/what-function-display-does-ijulia-call-at-the-end-of-each-cell/33554
JuliaLang · Jan 20, 2020 · a3ee6fe · a3ee6fe · nanosoldier · Jan 20, 2020
1 parent 5928786
commit a3ee6fe
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/base/multimedia.jl b/base/multimedia.jl
@@ -315,6 +315,9 @@ a `MethodError` if this type is not supported by either the display(s) or by `x`
 variants, one can also supply the "raw" data in the requested MIME type by passing
 `x::AbstractString` (for MIME types with text-based storage, such as text/html or
 application/postscript) or `x::Vector{UInt8}` (for binary MIME types).
+
+To customize how instances of a type are displayed, overload [`show`](@ref) rather than `display`,
+as explained in the manual section on [custom pretty-printing](@id man-custom-pretty-printing).
 """
 function display(@nospecialize x)
     for i = length(displays):-1:1