GNU bug report logs - #11342
24.1.50; HOOK variable name in `add-hook' etc. confusing

Previous Next

Full log

Message #25 received at 11342-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: michael_heerdegen <at> web.de
Cc: 11342-done <at> debbugs.gnu.org
Subject: Re: bug#11342: 24.1.50;
	HOOK variable name in `add-hook' etc. confusing
Date: Tue, 15 May 2012 10:46:54 -0400

>   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.

Actually, the docstring says "HOOK should be a symbol", so the problem
is only that you base your decision on the eldoc info, which is
necessarily too limited to be trusted to give that kind of detail.

I find that changing the argument name makes the code and docstring too
verbose for my taste, so I don't think it's worth the trouble.


        Stefan

Previous Next

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