[nongnu] elpa/swsw db5cd237a7 125/146: ; Documentation improvements

[ELPA Syncer]

branch: elpa/swsw
commit db5cd237a7d5b4a953f89e527b1497c13696e2a4
Author: Daniel Semyonov <daniel@dsemy.com>
Commit: Daniel Semyonov <daniel@dsemy.com>

    ; Documentation improvements
---
 swsw.el   | 19 ++++++++++---------
 swsw.texi | 11 ++++++-----
 2 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/swsw.el b/swsw.el
index 57ff2defd8..40afc7d40c 100644
--- a/swsw.el
+++ b/swsw.el
@@ -207,6 +207,8 @@ If set to `lighter', use a mode line lighter."
     (set-window-parameter window 'swsw-id id)
     (setq swsw-window-count (1+ swsw-window-count))))
 
+;; This is a separate function only to prevent running `swsw--update'
+;; on any window state change.
 (defun swsw--update-frame ()
   "Run `swsw--update' if the current frame isn't `swsw--current-frame'.
 This check is skipped (and this function does nothing) if `swsw-scope'
@@ -295,8 +297,7 @@ If less than three windows have been assigned an ID, switch 
to the
 window returned by `next-window'.
 Otherwise, window selection allows either choosing a window by its ID
 \(switching to it), or using a window manipulation command.
-This command is intended to be used only when simple window switching
-is enabled."
+This command is intended to be used only when swsw mode is enabled."
   (declare (modes swsw-mode))
   (interactive)
   (if (< swsw-window-count 3)
@@ -305,8 +306,7 @@ is enabled."
 
 (defun swsw-select-minibuffer ()
   "Select the active minibuffer window (if it exists).
-This command is intended to be used only when simple window switching
-is enabled."
+This command is intended to be used only when swsw mode is enabled."
   (declare (modes swsw-mode))
   (interactive)
   (let ((window (active-minibuffer-window)))
@@ -319,8 +319,7 @@ If less than three windows have been assigned an ID, delete 
the window
 returned by `next-window'.
 Otherwise, window deletion allows either choosing a window by its ID
 \(deleting it), or using a window manipulation command.
-This command is intended to be used only when simple window switching
-is enabled."
+This command is intended to be used only when swsw mode is enabled."
   (declare (modes swsw-mode))
   (interactive)
   (if (< swsw-window-count 3)
@@ -340,13 +339,15 @@ is enabled."
 This key map is set as the parent of `swsw--id-map' during ID
 selection.")
 
-;;;; Simple window switching mode:
+;;;; swsw mode:
 
 ;;;###autoload
 (define-minor-mode swsw-mode
-  "Minor mode for simple window management.
+  "Toggle swsw mode.
 
-When the mode is active, `other-window' is remapped to `swsw-select'.
+When swsw mode is enabled, window IDs are shown as mode line
+lighters of the form \"<ID>\" (by default), and `other-window' is remapped to
+`swsw-select' (a command used to select windows according to their ID).
 
 The following key bindings are available after starting window
 selection:
diff --git a/swsw.texi b/swsw.texi
index 9781fb9510..2fdf721913 100644
--- a/swsw.texi
+++ b/swsw.texi
@@ -130,19 +130,20 @@ Install the package:
 
 In order to use any feature of the package, @code{swsw-mode} must be enabled:
 
-@cindex swsw-mode
 @table @asis
+@cindex swsw-mode
 @item @kbd{M-x swsw-mode RET}
 You can also add @code{(swsw-mode)} to your init file, instead.
 @end table
 
-By default, window IDs are shown as mode line lighters of the
-form @code{<ID>} (@xref{Display functions}), and @code{other-window}
-(@kbd{C-x o}) is remapped to @code{swsw-select}.
+When @code{swsw-mode} is enabled, window IDs are shown as mode line
+lighters of the form @code{<ID>} (by default, @xref{Display
+functions}), and @code{other-window} (@kbd{C-x o}) is remapped to
+@code{swsw-select}.
 
+@table @asis
 @kindex C-x o
 @cindex swsw-select
-@table @asis
 @item @kbd{C-x o}
 Start window selection (@code{swsw-select}).
 This command sets a transient key map in which several window