GNU bug report logs - #25106
24.5; easy-menu doc strings

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Sun, 4 Dec 2016 17:07:01 UTC

Severity: minor

Tags: wontfix

Found in version 24.5

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 25106 <at> debbugs.gnu.org
Subject: bug#25106: 24.5; easy-menu doc strings
Date: Sun, 28 Jul 2019 09:40:59 -0700 (PDT)
> > Dunno - that was 3 years ago.  Maybe take a look
> > at the easy-menu doc strings? ;-)
> 
> I skimmed a few, and nothing really jumped stood out.  Closing this bug
> report; if somebody has a specific enhancement request in this area
> they can open a new one.

OK, looking quickly at `easy-mmode.el':


1. Doc string of `easy-mmode-defmap' says it defines
   a constant whose value has the form of the return
   value of `easy-mmode-define-keymap'.  Doc string
   of `easy-mmode-define-keymap' does not specify the
   form of the keymap it returns.  (And keymaps can
   have very different kinds of entries.)

2. (Emacs 24.5, which is where the bug was filed, did
   the same thing for `define-minor-mode': referred
   to the form of what `easy-mmode-define-keymap'
   returns.  That's since been removed.)

Please have the doc string of `easy-mmode-define-keymap'
make clear just what the form of the keymap is that
it returns.  Easy-menu returns a specific kind of
keymap, and that's not clear from the doc.




This bug report was last modified 5 years and 349 days ago.

Previous Next


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