]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve 'terminal-live-p' docstring some more
authorRobert Pluim <rpluim@gmail.com>
Fri, 22 Jul 2022 12:03:01 +0000 (14:03 +0200)
committerRobert Pluim <rpluim@gmail.com>
Fri, 22 Jul 2022 12:10:10 +0000 (14:10 +0200)
* terminal.c (Fterminal_live_p): Improve description of arguments and
return value.

src/terminal.c

index 39ba3925b7228454f988e82ff507da44a55cdcf3..4580d0b7267a743df55be79534ae6dcacfc042d2 100644 (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);