diff options
author | Eli Zaretskii <eliz@gnu.org> | 2022-01-22 16:49:06 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2022-01-22 16:49:06 +0200 |
commit | 71b433f0358807dca722c5b0b178d108b9d13436 (patch) | |
tree | e9d9ffe05b834854e62bcaa55f734f2ae376c290 /doc/lispref/streams.texi | |
parent | 41846901e22e824f02796012164c51df0297c6ec (diff) | |
download | emacs-71b433f0358807dca722c5b0b178d108b9d13436.tar.gz emacs-71b433f0358807dca722c5b0b178d108b9d13436.tar.bz2 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 'doc/lispref/streams.texi')
-rw-r--r-- | doc/lispref/streams.texi | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/lispref/streams.texi b/doc/lispref/streams.texi index b93a7610fa0..784adb9bd51 100644 --- a/doc/lispref/streams.texi +++ b/doc/lispref/streams.texi @@ -359,10 +359,12 @@ non-@code{nil} value and does nothing except flushing pending output. @end defun @defun readablep object -This predicate says whether @var{object} can be written out and then -read back by the Emacs Lisp reader. If it can't, this function -returns @code{nil}, and if it can, a printed representation (via -@code{prin1}) of @var{object} is returned. +@cindex readable syntax +This predicate says whether @var{object} has @dfn{readable syntax}, +i.e., it can be written out and then read back by the Emacs Lisp +reader. If it can't, this function returns @code{nil}; if it can, +this function returns a printed representation (via @code{prin1}, +@pxref{Output Functions}) of @var{object}. @end defun @node Output Streams @@ -889,8 +891,8 @@ instance: @end example If this variable is non-@code{nil}, it should be a function that will -be called to handle printing of these objects. The first argument is -the object, and the second argument is the @var{noescape} flag used by +be called to handle printing of these objects. The function will be +called with two arguments: the object and the @var{noescape} flag used by the printing functions (@pxref{Output Functions}). The function should return either @code{nil} (print nothing), or a |