diff options
author | Martin Rudalics <rudalics@gmx.at> | 2020-01-05 09:59:01 +0100 |
---|---|---|
committer | Martin Rudalics <rudalics@gmx.at> | 2020-01-05 09:59:01 +0100 |
commit | 448df8fec7a7fb3fe558749591e657e8a84cb46b (patch) | |
tree | bba8b36fdfcdd8690aa4ec2f1ea55bf51f047ba5 /lisp/window.el | |
parent | 7f01dfca5600fcd3e3548aee50734aab4b96b02f (diff) | |
download | emacs-448df8fec7a7fb3fe558749591e657e8a84cb46b.tar.gz |
Improve doc-strings of 'quit-window' and 'quit-restore-window' (Bug#38819)
* lisp/window.el (quit-restore-window, quit-window): Make
doc-strings more consistent; add references to corresponding
section of the Elisp manual (Bug#38819).
Diffstat (limited to 'lisp/window.el')
-rw-r--r-- | lisp/window.el | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/lisp/window.el b/lisp/window.el index 433486385d9..40c4bf5ad47 100644 --- a/lisp/window.el +++ b/lisp/window.el @@ -4970,9 +4970,11 @@ WINDOW must be a live window and defaults to the selected one. According to information stored in WINDOW's `quit-restore' window parameter either (1) delete WINDOW and its frame, (2) delete -WINDOW, (3) restore the buffer previously displayed in WINDOW, -or (4) make WINDOW display some other buffer than the present -one. If non-nil, reset `quit-restore' parameter to nil. +WINDOW but leave its frame alone, (3) restore the buffer +previously shown in WINDOW, or (4) make WINDOW display some other +buffer. If WINDOW is not deleted, reset its `quit-restore' +parameter to nil. See Info node `(elisp) Quitting Windows' for +more details. Optional second argument BURY-OR-KILL tells how to proceed with the buffer of WINDOW. The following values are handled: @@ -5083,11 +5085,9 @@ WINDOW must be a live window and defaults to the selected one. With prefix argument KILL non-nil, kill the buffer instead of burying it. -According to information stored in WINDOW's `quit-restore' window -parameter either (1) delete WINDOW and its frame, (2) delete -WINDOW, (3) restore the buffer previously displayed in WINDOW, -or (4) make WINDOW display some other buffer than the present -one. If non-nil, reset `quit-restore' parameter to nil. +This calls the function `quit-restore-window' to delete WINDOW or +show some other buffer in it. See Info node `(elisp) Quitting +Windows' for more details. The functions in `quit-window-hook' will be run before doing anything else." |