From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#8285: 24.0.50; doc of `imenu-generic-expression' and `imenu--generic-function' Date: Fri, 18 Mar 2011 20:22:46 +0200 Message-ID: <838vwcs2yx.fsf@gnu.org> References: <6CAA58C0292943D68651BC3DB49A62C0@us.oracle.com> Reply-To: Eli Zaretskii NNTP-Posting-Host: lo.gmane.org X-Trace: dough.gmane.org 1300473445 25221 80.91.229.12 (18 Mar 2011 18:37:25 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 18 Mar 2011 18:37:25 +0000 (UTC) Cc: 8285@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Mar 18 19:37:21 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Q0eY1-0003Lf-4x for geb-bug-gnu-emacs@m.gmane.org; Fri, 18 Mar 2011 19:37:18 +0100 Original-Received: from localhost ([127.0.0.1]:46617 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Q0eXz-0005UU-HH for geb-bug-gnu-emacs@m.gmane.org; Fri, 18 Mar 2011 14:37:15 -0400 Original-Received: from [140.186.70.92] (port=52801 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Q0eXn-0005To-Qq for bug-gnu-emacs@gnu.org; Fri, 18 Mar 2011 14:37:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Q0eXl-0006Bv-L1 for bug-gnu-emacs@gnu.org; Fri, 18 Mar 2011 14:37:02 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:36758) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Q0eXl-0006Br-IH for bug-gnu-emacs@gnu.org; Fri, 18 Mar 2011 14:37:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1Q0eKE-0006bD-Gi; Fri, 18 Mar 2011 14:23:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 18 Mar 2011 18:23:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 8285 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 8285-submit@debbugs.gnu.org id=B8285.130047257325352 (code B ref 8285); Fri, 18 Mar 2011 18:23:02 +0000 Original-Received: (at 8285) by debbugs.gnu.org; 18 Mar 2011 18:22:53 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Q0eK5-0006aq-0Y for submit@debbugs.gnu.org; Fri, 18 Mar 2011 14:22:53 -0400 Original-Received: from mtaout23.012.net.il ([80.179.55.175]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Q0eK2-0006ad-6F for 8285@debbugs.gnu.org; Fri, 18 Mar 2011 14:22:51 -0400 Original-Received: from conversion-daemon.a-mtaout23.012.net.il by a-mtaout23.012.net.il (HyperSendmail v2007.08) id <0LI900200MVIN200@a-mtaout23.012.net.il> for 8285@debbugs.gnu.org; Fri, 18 Mar 2011 20:22:43 +0200 (IST) Original-Received: from HOME-C4E4A596F7 ([77.124.131.120]) by a-mtaout23.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0LI9002G5N1TM320@a-mtaout23.012.net.il>; Fri, 18 Mar 2011 20:22:43 +0200 (IST) In-reply-to: <6CAA58C0292943D68651BC3DB49A62C0@us.oracle.com> X-012-Sender: halo1@inter.net.il X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Fri, 18 Mar 2011 14:23:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:45152 Archived-At: > From: "Drew Adams" > Date: Fri, 18 Mar 2011 09:09:47 -0700 > Cc: > > If you don't understand the problem, change these names to UU, VV, > WW, XX, YY, and ZZ, and see if you understand the doc. This argument is bogus: names of symbols can and should bear significant semantic information that helps to understand their roles, and if that information is descriptive enough, there's no need for any further definitions. As an extreme example, consider: (defun call-func (function &rest arguments) "Call FUNCTION with ARGUMENTS." I see no need to explain the arguments in this example. I'm not saying that the doc string in question could not use some improvement. But since imenu is about creating indices of functions in a program source file, at least FUNCTION and ARGUMENTS do not need any further explanations, IMO.