procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve 'terminal-live-p' docstring some more

Browse source 
* 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
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/terminal.c
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, 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. 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 Return nil if OBJECT is not a live display terminal.
terminal of the currently selected frame if OBJECT is nil. OBJECT may be a terminal object, a frame, or nil (meaning the
If object is a live display terminal, the return value indicates what selected frame's terminal).
sort of output terminal it uses. See the documentation of `framep' for If OBJECT is a live display terminal, return what sort of output
possible return values. */) terminal it uses. See the documentation of `framep' for possible
return values. */)
(Lisp_Object object) (Lisp_Object object)
{ {
struct terminal *t = decode_terminal (object); struct terminal *t = decode_terminal (object);