[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master 2c3ab9b: Add a doc string to `winner-mode'
From: |
Lars Ingebrigtsen |
Subject: |
[Emacs-diffs] master 2c3ab9b: Add a doc string to `winner-mode' |
Date: |
Fri, 29 Apr 2016 20:28:42 +0000 |
branch: master
commit 2c3ab9b6e39a3d600e7d82deacc24effaec051bb
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>
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).
---
lisp/winner.el | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/lisp/winner.el b/lisp/winner.el
index 4b27700..9a6f5d5 100644
--- a/lisp/winner.el
+++ b/lisp/winner.el
@@ -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)
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] master 2c3ab9b: Add a doc string to `winner-mode',
Lars Ingebrigtsen <=