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

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

[Stefan Kangas]

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'?

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

[Stefan Kangas]

Version: 29.2

Stefan Kangas <stefankangas@gmail.com> writes:

> 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'?

I've now changed this example to `make-syntax-table' on emacs-29.

If anyone can think of a better example, please speak up and we can
reopen the bug for further tweaking.