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

Improve doc-strings of 'quit-window' and 'quit-restore-window' (Bug#38819)

Browse source 
* lisp/window.el (quit-restore-window, quit-window): Make
doc-strings more consistent; add references to corresponding
section of the Elisp manual (Bug#38819).
This commit is contained in:
Martin Rudalics 2020-01-05 09:59:01 +01:00
parent 7f01dfca56
commit 448df8fec7
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
lisp/window.el
View file

@ -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 According to information stored in WINDOW's `quit-restore' window
parameter either (1) delete WINDOW and its frame, (2) delete parameter either (1) delete WINDOW and its frame, (2) delete
WINDOW, (3) restore the buffer previously displayed in WINDOW, WINDOW but leave its frame alone, (3) restore the buffer
or (4) make WINDOW display some other buffer than the present previously shown in WINDOW, or (4) make WINDOW display some other
one. If non-nil, reset `quit-restore' parameter to nil. 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 Optional second argument BURY-OR-KILL tells how to proceed with
the buffer of WINDOW. The following values are handled: 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 With prefix argument KILL non-nil, kill the buffer instead of
burying it. burying it.
According to information stored in WINDOW's `quit-restore' window This calls the function `quit-restore-window' to delete WINDOW or
parameter either (1) delete WINDOW and its frame, (2) delete show some other buffer in it. See Info node `(elisp) Quitting
WINDOW, (3) restore the buffer previously displayed in WINDOW, Windows' for more details.
or (4) make WINDOW display some other buffer than the present
one. If non-nil, reset `quit-restore' parameter to nil.
The functions in `quit-window-hook' will be run before doing The functions in `quit-window-hook' will be run before doing
anything else." anything else."