unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#11342: 24.1.50; HOOK variable name in `add-hook' etc. confusing
@ 2012-04-25 22:45 Michael Heerdegen
  2012-04-26  1:15 ` Stefan Monnier
  2012-05-15 14:46 ` Stefan Monnier
  0 siblings, 2 replies; 7+ messages in thread
From: Michael Heerdegen @ 2012-04-25 22:45 UTC (permalink / raw)
  To: 11342

Hi,

this is just a tiny detail, but confusing for newbies:

Turn on eldoc mode in any elisp buffer.  If you move point into an
`add-hook' or `remove-hook' form, you get e.g. the message

  remove-hook: (HOOK FUNCTION &optional LOCAL)

You could misinterpret that and think that the first argument must be
a value representing a hook.  But actually it must be a _symbol_
holding a hook.

So, I want to make the suggestion to replace the variable `hook' in
the definition of `remove-hook' by `hook-var', and to do the same for
`add-hook' and `run-hooks'.  Then, the eldoc message would be

  remove-hook: (HOOK-VAR FUNCTION &optional LOCAL)

which is more clear.


Thanks,

Michael.


In GNU Emacs 24.1.50.1 (i486-pc-linux-gnu, GTK+ Version 3.4.1)
 of 2012-04-23 on zelenka, modified by Debian
 (emacs-snapshot package, version 2:20120423-1)
Windowing system distributor `The X.Org Foundation', version 11.0.11104000
Configured using:
 `configure '--build' 'i486-linux-gnu' '--host' 'i486-linux-gnu'
 '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib'
 '--localstatedir=/var' '--infodir=/usr/share/info'
 '--mandir=/usr/share/man' '--with-pop=yes'
 '--enable-locallisppath=/etc/emacs-snapshot:/etc/emacs:/usr/local/share/emacs/24.1.50/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/24.1.50/site-lisp:/usr/share/emacs/site-lisp'
 '--without-compress-info' '--with-crt-dir=/usr/lib/i386-linux-gnu/'
 '--with-x=yes' '--with-x-toolkit=gtk3' '--with-imagemagick=yes'
 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu'
 'CFLAGS=-DDEBIAN -DSITELOAD_PURESIZE_EXTRA=5000 -g -O2''






^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2012-05-15 14:46 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-04-25 22:45 bug#11342: 24.1.50; HOOK variable name in `add-hook' etc. confusing Michael Heerdegen
2012-04-26  1:15 ` Stefan Monnier
2012-04-26  2:07   ` Michael Heerdegen
2012-04-26  8:03     ` Andreas Schwab
2012-04-26 12:47       ` Stefan Monnier
2012-04-26 21:31       ` Michael Heerdegen
2012-05-15 14:46 ` Stefan Monnier

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).