From: Stefan Kangas <stefan@marxist.se>
Date: Sat, 6 Aug 2022 14:47:22 +0000 (+0200)
Subject: Fix defvar-keymap example in elisp manual
X-Git-Tag: emacs-29.0.90~1447^2~364
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=a3e894810a484aeac56d97f13d1c507e3d4eb0d5;p=emacs.git

Fix defvar-keymap example in elisp manual

* lisp/textmodes/text-mode.el (text-mode-map): Convert to
defvar-keymap.
* doc/lispref/modes.texi (Example Major Modes): Fix example to
match code.
---

diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index e94093318fc..75eb21522f1 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -1356,11 +1356,10 @@ the conventions listed above:
 ;; @r{Create the keymap for this mode.}
 @group
 (defvar-keymap text-mode-map
-  "C-M-i" #'ispell-complete-word
-  @dots{})
-  "Keymap for `text-mode'.
-Many other modes, such as `mail-mode', `outline-mode' and
-`indented-text-mode', inherit all the commands defined in this map.")
+  :doc "Keymap for `text-mode'.
+Many other modes, such as `mail-mode' and `outline-mode', inherit all
+the commands defined in this map."
+  "C-M-i" #'ispell-complete-word)
 @end group
 @end smallexample
 
diff --git a/lisp/textmodes/text-mode.el b/lisp/textmodes/text-mode.el
index 2275ab2a3ce..9e8f3747c5f 100644
--- a/lisp/textmodes/text-mode.el
+++ b/lisp/textmodes/text-mode.el
@@ -67,13 +67,11 @@
     st)
   "Syntax table used while in `text-mode'.")
 
-(defvar text-mode-map
-  (let ((map (make-sparse-keymap)))
-    (define-key map "\e\t" #'ispell-complete-word)
-    map)
-  "Keymap for `text-mode'.
+(defvar-keymap text-mode-map
+  :doc "Keymap for `text-mode'.
 Many other modes, such as `mail-mode' and `outline-mode', inherit
-all the commands defined in this map.")
+all the commands defined in this map."
+  "C-M-i" #'ispell-complete-word)
 
 (easy-menu-define text-mode-menu text-mode-map
   "Menu for `text-mode'."