diff options
| author | Martin Rudalics | 2020-01-05 09:59:01 +0100 |
|---|---|---|
| committer | Martin Rudalics | 2020-01-05 09:59:01 +0100 |
| commit | 448df8fec7a7fb3fe558749591e657e8a84cb46b (patch) | |
| tree | bba8b36fdfcdd8690aa4ec2f1ea55bf51f047ba5 | |
| parent | 7f01dfca5600fcd3e3548aee50734aab4b96b02f (diff) | |
| download | emacs-448df8fec7a7fb3fe558749591e657e8a84cb46b.tar.gz emacs-448df8fec7a7fb3fe558749591e657e8a84cb46b.zip | |
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).
| -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. | |||
| 4970 | 4970 | ||
| 4971 | According to information stored in WINDOW's `quit-restore' window | 4971 | According to information stored in WINDOW's `quit-restore' window |
| 4972 | parameter either (1) delete WINDOW and its frame, (2) delete | 4972 | parameter either (1) delete WINDOW and its frame, (2) delete |
| 4973 | WINDOW, (3) restore the buffer previously displayed in WINDOW, | 4973 | WINDOW but leave its frame alone, (3) restore the buffer |
| 4974 | or (4) make WINDOW display some other buffer than the present | 4974 | previously shown in WINDOW, or (4) make WINDOW display some other |
| 4975 | one. If non-nil, reset `quit-restore' parameter to nil. | 4975 | buffer. If WINDOW is not deleted, reset its `quit-restore' |
| 4976 | parameter to nil. See Info node `(elisp) Quitting Windows' for | ||
| 4977 | more details. | ||
| 4976 | 4978 | ||
| 4977 | Optional second argument BURY-OR-KILL tells how to proceed with | 4979 | Optional second argument BURY-OR-KILL tells how to proceed with |
| 4978 | the buffer of WINDOW. The following values are handled: | 4980 | 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. | |||
| 5083 | With prefix argument KILL non-nil, kill the buffer instead of | 5085 | With prefix argument KILL non-nil, kill the buffer instead of |
| 5084 | burying it. | 5086 | burying it. |
| 5085 | 5087 | ||
| 5086 | According to information stored in WINDOW's `quit-restore' window | 5088 | This calls the function `quit-restore-window' to delete WINDOW or |
| 5087 | parameter either (1) delete WINDOW and its frame, (2) delete | 5089 | show some other buffer in it. See Info node `(elisp) Quitting |
| 5088 | WINDOW, (3) restore the buffer previously displayed in WINDOW, | 5090 | Windows' for more details. |
| 5089 | or (4) make WINDOW display some other buffer than the present | ||
| 5090 | one. If non-nil, reset `quit-restore' parameter to nil. | ||
| 5091 | 5091 | ||
| 5092 | The functions in `quit-window-hook' will be run before doing | 5092 | The functions in `quit-window-hook' will be run before doing |
| 5093 | anything else." | 5093 | anything else." |