diff options
| author | Eli Zaretskii | 2022-01-22 16:49:06 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2022-01-22 16:49:06 +0200 |
| commit | 71b433f0358807dca722c5b0b178d108b9d13436 (patch) | |
| tree | e9d9ffe05b834854e62bcaa55f734f2ae376c290 /src | |
| parent | 41846901e22e824f02796012164c51df0297c6ec (diff) | |
| download | emacs-71b433f0358807dca722c5b0b178d108b9d13436.tar.gz emacs-71b433f0358807dca722c5b0b178d108b9d13436.zip | |
Fix documentation of 'unprintable' stuff
* src/print.c (syms_of_print) <print-unreadable-function>:
* doc/lispref/streams.texi (Input Functions, Output Variables):
Improve the documentation of 'print-unreadable-function' and
'readablep'. Add indexing and cross-references.
Diffstat (limited to 'src')
| -rw-r--r-- | src/print.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/print.c b/src/print.c index 4d9feb55ac2..e9a83d6d5dc 100644 --- a/src/print.c +++ b/src/print.c | |||
| @@ -2498,15 +2498,15 @@ priorities. Values other than nil or t are also treated as | |||
| 2498 | staticpro (&print_prune_charset_plist); | 2498 | staticpro (&print_prune_charset_plist); |
| 2499 | 2499 | ||
| 2500 | DEFVAR_LISP ("print-unreadable-function", Vprint_unreadable_function, | 2500 | DEFVAR_LISP ("print-unreadable-function", Vprint_unreadable_function, |
| 2501 | doc: /* Function called when printing unreadable objects. | 2501 | doc: /* If non-nil, a function to call when printing unreadable objects. |
| 2502 | By default, Emacs printing functions (like `prin1') print unreadable | 2502 | By default, Emacs printing functions (like `prin1') print unreadable |
| 2503 | objects like \"#<...>\", where \"...\" describes the object (for | 2503 | objects as \"#<...>\", where \"...\" describes the object (for |
| 2504 | instance, \"#<marker in no buffer>\"). If this variable is non-nil, | 2504 | instance, \"#<marker in no buffer>\"). If this variable is non-nil, |
| 2505 | it should be a function which will be called to print the object instead. | 2505 | it should be a function which will be called to print the object instead. |
| 2506 | 2506 | ||
| 2507 | It will be called with two arguments: The object to be printed, and | 2507 | The function will be called with two arguments: the object to be printed, and |
| 2508 | noescape (see `prin1-to-string'). If this function returns nil, the | 2508 | the NOESCAPE flag (see `prin1-to-string'). If this function returns nil, the |
| 2509 | object will be printed as normal. If it returns a string, that string | 2509 | object will be printed as usual. If it returns a string, that string |
| 2510 | will then be printed. If the function returns anything else, the | 2510 | will then be printed. If the function returns anything else, the |
| 2511 | object will not be printed. */); | 2511 | object will not be printed. */); |
| 2512 | Vprint_unreadable_function = Qnil; | 2512 | Vprint_unreadable_function = Qnil; |