GNU bug report logs - #59224
29.0.50; Don't use defvar+make-sparse-keymap for example in docs

Previous Next

Package: emacs;

Reported by: Stefan Kangas <stefankangas <at> gmail.com>

Date: Sat, 12 Nov 2022 20:03:02 UTC

Severity: wishlist

Found in version 29.0.50

Fixed in version 29.2

Done: Stefan Kangas <stefankangas <at> gmail.com>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Stefan Kangas <stefankangas <at> gmail.com>
To: 59224 <at> debbugs.gnu.org
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>
Subject: bug#59224: 29.0.50; Don't use defvar+make-sparse-keymap for example in docs
Date: Sat, 12 Nov 2022 12:02:31 -0800

Severity: wishlist

In (info "(elisp) Tips for Defining"), we have:

       When defining and initializing a variable that holds a
    complicated value (such as a keymap with bindings in it), it’s best
    to put the entire computation of the value into the ‘defvar’, like
    this:

         (defvar my-mode-map
           (let ((map (make-sparse-keymap)))
             (keymap-set map "C-c C-a" 'my-command)
             ...
             map)
           DOCSTRING)

Could we use an example here that is not a keymap (which should be
defined using `defvar-keymap' these days)?

What would be a good example to use?  `make-syntax-table'?
This bug report was last modified 1 year and 310 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.