1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-02 11:21:42 +00:00

Add a doc string to `winner-mode'

* lisp/winner.el (winner-mode): Add a doc string based on the
comments in the file (bug#17716).

(cherry picked from commit 2c3ab9b6e3)
This commit is contained in:
Lars Ingebrigtsen 2016-04-29 22:28:02 +02:00
parent 02c1aa8fe5
commit 8748c21f71

View File

@ -346,7 +346,19 @@ You may want to include buffer names such as *Help*, *Apropos*,
;;;###autoload
(define-minor-mode winner-mode nil :global t ; let d-m-m make the doc
(define-minor-mode winner-mode
"Toggle Winner mode on or off.
With a prefix argument ARG, enable Winner mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil, and toggle it if ARG is toggle.
Winner mode is a global minor mode that records the changes in
the window configuration (i.e. how the frames are partitioned
into windows) so that the changes can be \"undone\" using the
command `winner-undo'. By default this one is bound to the key
sequence `C-c <left>'. If you change your mind (while undoing),
you can press `C-c <right>' (calling `winner-redo')."
:global t
(if winner-mode
(progn
(add-hook 'window-configuration-change-hook 'winner-change-fun)