Clarify Vprint_unreadable_function doc string

* src/print.c (syms_of_print): Clarify Vprint_unreadable_function
doc string
This commit is contained in:
Lars Ingebrigtsen 2022-01-22 16:24:42 +01:00
parent 71b433f035
commit 3b33a14380

View file

@ -2501,14 +2501,14 @@ priorities. Values other than nil or t are also treated as
doc: /* If non-nil, a function to call when printing unreadable objects.
By default, Emacs printing functions (like `prin1') print unreadable
objects as \"#<...>\", where \"...\" describes the object (for
instance, \"#<marker in no buffer>\"). If this variable is non-nil,
it should be a function which will be called to print the object instead.
instance, \"#<marker in no buffer>\").
The function will be called with two arguments: the object to be printed, and
the NOESCAPE flag (see `prin1-to-string'). If this function returns nil, the
object will be printed as usual. If it returns a string, that string
will then be printed. If the function returns anything else, the
object will not be printed. */);
If non-nil, it should be a function that will be called with two
arguments: the object to be printed, and the NOESCAPE flag (see
`prin1-to-string'). If this function returns nil, the object will be
printed as usual. If it returns a string, that string will then be
printed. If the function returns anything else, the object will not
be printed. */);
Vprint_unreadable_function = Qnil;
DEFSYM (Qprint_unreadable_function, "print-unreadable-function");
}