Improve 'terminal-live-p' docstring some more

* terminal.c (Fterminal_live_p): Improve description of arguments and
return value.
This commit is contained in:
Robert Pluim 2022-07-22 14:03:01 +02:00
parent b9ac8c29ae
commit 7fa491a9e9

View file

@ -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);