]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify Vprint_unreadable_function doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 22 Jan 2022 15:24:42 +0000 (16:24 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 22 Jan 2022 15:24:42 +0000 (16:24 +0100)
* src/print.c (syms_of_print): Clarify Vprint_unreadable_function
doc string

src/print.c

index e9a83d6d5dcc00bb6d98eac148ece68ba7de1f77..7440a82f6fde43946ca21f003380c90efc26b854 100644 (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.
-
-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.  */);
+instance, \"#<marker in no buffer>\").
+
+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");
 }