GNU bug report logs - #5612
23.1.92; Help does not show doc for command bound to mouse event

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 5612 in the body.
You can then email your comments to 5612 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>, <emacs-pretest-bug <at> gnu.org>
Subject: 23.1.92; Help does not show doc for command bound to mouse event
Date: Sat, 20 Feb 2010 15:35:57 -0800

emacs -Q

Load these files, in order:

frame-fns.el
frame-cmds.el
zoom-frm.el

The files are available here:
http://www.emacswiki.org/cgi-bin/wiki?action=index;match=%5C.(el%7Ctar)(%5C.gz)%
3F%24

Evaluate this:

(global-set-key [S-mouse-1] 'zoom-in)

`C-h k' click `S-mouse-1'

You'll see this:

 <mouse-1> at that spot runs the command zoom-in, which is an
 interactive Lisp function in `zoom-frm.el'.

 It is bound to <S-mouse-1>.

 (zoom-in ARG)

 Not documented.

That's false; it is documented. This is the doc string:

 "Zoom current frame or buffer in.
  With a prefix arg, toggle between zooming frame and zooming buffer.
  Frame zooming uses command `zoom-frm-in'. 
  Buffer zooming uses command `text-scale-increase'."

Even worse: If you byte-compile the files and load only the *.elc, then Help
does not even tell you where the command is defined. It says only this:

 <mouse-1> at that spot runs the command zoom-in, which is an
 interactive compiled Lisp function.

 It is bound to <S-mouse-1>.

 (zoom-in ARG)

 Not documented.

In GNU Emacs 23.1.92.1 (i386-mingw-nt5.1.2600)
 of 2010-02-20 on LENNART-69DE564
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include
-fno-crossjumping'

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

From: Chong Yidong <cyd <at> stupidchicken.com>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 5612 <at> debbugs.gnu.org
Subject: Re: 23.1.92; Help does not show doc for command bound to mouse event
Date: Tue, 06 Jul 2010 15:41:30 -0400

>  (zoom-in ARG)
>
>  Not documented.
>
> That's false; it is documented. This is the doc string:

In your source file, you got the interactive call and the docstring
mixed up:

  (defun zoom-in (arg)
    (interactive "P")
    "Zoom current frame or buffer in...

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Chong Yidong'" <cyd <at> stupidchicken.com>
Cc: 5612 <at> debbugs.gnu.org
Subject: RE: 23.1.92; Help does not show doc for command bound to mouse event
Date: Tue, 6 Jul 2010 12:49:50 -0700

> From: Chong Yidong Sent: Tuesday, July 06, 2010 12:42 PM
> >  (zoom-in ARG)
> >  Not documented.
> > That's false; it is documented. This is the doc string:
> 
> In your source file, you got the interactive call and the docstring
> mixed up:
> 
>   (defun zoom-in (arg)
>     (interactive "P")
>     "Zoom current frame or buffer in...

Oooops.  Thanks.

Sorry about that.  I should have checked that before filing a bug report.

Previous Next

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