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).

diff --git a/lisp/winner.el b/lisp/winner.el
index 4b277008d7845d46a334c04fead04594f735e2d8..9a6f5d5190be1f82455003e6178120f73bb3bf7c 100644 (file)
--- a/lisp/winner.el
+++ b/lisp/winner.el
@@ -346,7 +346,19 @@ You may want to include buffer names such as *Help*, *Apropos*,
 
 \f
 ;;;###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)