From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 4 Jun 2021 06:48:13 +0000 (+0300)
Subject: Fix documentation of recent 'windmove' changes
X-Git-Tag: emacs-28.0.90~2199
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b516887283ce77cf3c0977154f713ef485e3e8a9;p=emacs.git

Fix documentation of recent 'windmove' changes

* lisp/windmove.el (windmove-default-keybindings)
(windmove-display-default-keybindings)
(windmove-delete-default-keybindings)
(windmove-swap-states-default-keybindings): Improve doc strings.
(Bug#41438)

* etc/NEWS: Fix a typo in the 'windmove' entry.
---

diff --git a/etc/NEWS b/etc/NEWS
index 8b207001fe5..675925906cb 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -557,8 +557,8 @@ disabled entirely.
 
 ** Windmove
 
-*** New user options can be used to customize windmove keybindings.
-There options include 'windmove-default-keybindings',
+*** New user options to customize windmove keybindings.
+These options include 'windmove-default-keybindings',
 'windmove-display-default-keybindings',
 'windmove-delete-default-keybindings',
 'windmove-swap-states-default-keybindings'.
diff --git a/lisp/windmove.el b/lisp/windmove.el
index 0eba97a91b7..f5589036812 100644
--- a/lisp/windmove.el
+++ b/lisp/windmove.el
@@ -749,7 +749,8 @@ Default value of MODIFIERS is `shift-super'."
   "Customisation type for windmove modifiers.")
 
 (defcustom windmove-default-keybindings nil
-  "Default bindings for regular windmove commands."
+  "Default keybindings for regular windmove commands.
+See `windmove-default-keybindings' for more detail."
   :set (lambda (sym val)
          (windmove-install-defaults
           (car val) (cdr val)
@@ -764,7 +765,8 @@ Default value of MODIFIERS is `shift-super'."
   :group 'windmove)
 
 (defcustom windmove-display-default-keybindings nil
-  "Default bindings for display windmove commands."
+  "Default keybindings for windmove directional buffer display commands.
+See `windmove-display-default-keybindings' for more detail."
   :set (lambda (sym val)
          (windmove-install-defaults
           (car val) (cdr val)
@@ -782,7 +784,8 @@ Default value of MODIFIERS is `shift-super'."
   :group 'windmove)
 
 (defcustom windmove-delete-default-keybindings nil
-  "Default bindings for delete windmove commands."
+  "Default keybindings for windmove directional window deletion commands.
+See `windmove-delete-default-keybindings' for more detail."
   :set (lambda (sym val)
          (windmove-install-defaults
           (car val) (cdr val)
@@ -797,7 +800,8 @@ Default value of MODIFIERS is `shift-super'."
   :group 'windmove)
 
 (defcustom windmove-swap-states-default-keybindings nil
-  "Default bindings for swap-state windmove commands."
+  "Default keybindings for windmove's directional window swap-state commands.
+See `windmove-swap-states-default-keybindings' for more detail."
   :set (lambda (sym val)
          (windmove-install-defaults
           (car val) (cdr val)