GNU bug report logs - #17709
24.3; `tool-bar-map' seems inadaquately documented

Previous Next

Full log

Message #8 received at 17709 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Samuel Bronson <naesten <at> gmail.com>
Cc: 17709 <at> debbugs.gnu.org
Subject: Re: bug#17709: 24.3; `tool-bar-map' seems inadaquately documented
Date: Sat, 12 Oct 2019 07:31:10 +0200

Samuel Bronson <naesten <at> gmail.com> writes:

> So, we have this:
> ,----[ C-h v tool-bar-map RET ]
> | tool-bar-map is a variable defined in `tool-bar.el'.
> [...]
> | Documentation:
> | Keymap for the tool bar.
> | Define this locally to override the global tool bar.
> [...]
> `----
>
> But we also have this:
> ,----[ C-h f tool-bar-make-keymap RET ]
> | tool-bar-make-keymap is a compiled Lisp function in `tool-bar.el'.
> | 
> | (tool-bar-make-keymap &optional IGNORE)
> | 
> | Generate an actual keymap from `tool-bar-map'.
> | Its main job is to figure out which images to use based on the display's
> | color capability and based on the available image libraries.
> `----
>
> It seems that the docs for the variable `tool-bar-map' are, at best,
> completely glossing over the fact that, while perhaps technically a
> keymap according to the defition in (info "(elisp) Format of Keymaps"),
> the value of this variable is not actually directly usable, which
> (presumably) has some special extra conditional stuff in it that the
> `tool-bar-make-keymap' function filters out.

I've now expanded the doc string here in Emacs 27 somewhat.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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