diff options
author | Robert Pluim <rpluim@gmail.com> | 2022-07-22 14:03:01 +0200 |
---|---|---|
committer | Robert Pluim <rpluim@gmail.com> | 2022-07-22 14:10:10 +0200 |
commit | 7fa491a9e9ca00b21a290926c971ae861791824e (patch) | |
tree | 0014ffd81d352d7f3b4ccd1a44952b3babb75362 | |
parent | b9ac8c29aec90b31b044137e1e056daacd8fa1f2 (diff) | |
download | emacs-7fa491a9e9ca00b21a290926c971ae861791824e.tar.gz emacs-7fa491a9e9ca00b21a290926c971ae861791824e.tar.bz2 emacs-7fa491a9e9ca00b21a290926c971ae861791824e.zip |
Improve 'terminal-live-p' docstring some more
* terminal.c (Fterminal_live_p): Improve description of arguments and
return value.
-rw-r--r-- | src/terminal.c | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/terminal.c b/src/terminal.c index 39ba3925b72..4580d0b7267 100644 --- a/src/terminal.c +++ b/src/terminal.c @@ -421,11 +421,12 @@ The terminal device is represented by its integer identifier. */) DEFUN ("terminal-live-p", Fterminal_live_p, Sterminal_live_p, 1, 1, 0, doc: /* Return non-nil if OBJECT is a terminal which has not been deleted. -Value is nil if OBJECT is not a live display terminal. Uses the -terminal of the currently selected frame if OBJECT is nil. -If object is a live display terminal, the return value indicates what -sort of output terminal it uses. See the documentation of `framep' for -possible return values. */) +Return nil if OBJECT is not a live display terminal. +OBJECT may be a terminal object, a frame, or nil (meaning the +selected frame's terminal). +If OBJECT is a live display terminal, return what sort of output +terminal it uses. See the documentation of `framep' for possible +return values. */) (Lisp_Object object) { struct terminal *t = decode_terminal (object); |