GNU bug report logs - #8757
24.0.50; `find-grep-options' - fn name doesn't fit doc string

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 8757 in the body.
You can then email your comments to 8757 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>
Subject: 24.0.50; `find-grep-options' - fn name doesn't fit doc string
Date: Sun, 29 May 2011 15:26:01 -0700

Maybe the function should be called `find-grep-silence-options' or
`find-grep-quiet-options'.  If the value is supposed to represent the
switches that make `grep' as silent as possible, then this is about
silence or quiet - it is not about options in general.  Also, in Emacs
we don't usually call these "options" - we call them "switches":
`find-grep-quiet-switches'.

Besides, the Emacs option just above this one is called
`find-ls-subdir-switches' - switches, not options.
 

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-05-23 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
 

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8757 <at> debbugs.gnu.org
Subject: Re: 24.0.50; `find-grep-options' - fn name doesn't fit doc string
Date: Fri, 15 Jul 2011 16:15:24 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> Maybe the function should be called `find-grep-silence-options' or
> `find-grep-quiet-options'.  If the value is supposed to represent the
> switches that make `grep' as silent as possible, then this is about
> silence or quiet - it is not about options in general.  Also, in Emacs
> we don't usually call these "options" - we call them "switches":
> `find-grep-quiet-switches'.
>
> Besides, the Emacs option just above this one is called
> `find-ls-subdir-switches' - switches, not options.

I agree that the variable name is not optimal, but it's not actively
misleading, and changing it would be of little benefit.  I'm closing
this report.

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

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi <at> gnus.org>
Cc: 8757 <at> debbugs.gnu.org
Subject: RE: 24.0.50; `find-grep-options' - fn name doesn't fit doc string
Date: Fri, 15 Jul 2011 08:24:30 -0700

> I agree that the variable name is not optimal, but it's not actively
> misleading, and changing it would be of little benefit.  I'm closing
> this report.

You apparently don't agree to changing _any_ names - at least so far.

That's silly.  Of course it would benefit users to give this a better name.  And
yes, Emacs does not call switches "options".  This is clearly a bug on at least
two levels.

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8757 <at> debbugs.gnu.org
Subject: Re: 24.0.50; `find-grep-options' - fn name doesn't fit doc string
Date: Fri, 15 Jul 2011 17:28:26 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> You apparently don't agree to changing _any_ names - at least so far.

I'm all for changing names if there's a compelling reason to do so.
`find-grep-options' doesn't seem like a compelling case, when weighed
against the problems associated with changing the name of a
user-customisable variable.

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