From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#31962: 27.0; imenu.el constructs - names and doc Date: Sat, 19 Oct 2019 03:09:14 +0200 Message-ID: References: <21dc18b7-5951-431b-940b-ab7e56bf8226@default> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="51005"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 31962-done@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Oct 19 03:10:12 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iLdG0-000DCF-8W for geb-bug-gnu-emacs@m.gmane.org; Sat, 19 Oct 2019 03:10:12 +0200 Original-Received: from localhost ([::1]:47478 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iLdFz-0001qV-3P for geb-bug-gnu-emacs@m.gmane.org; Fri, 18 Oct 2019 21:10:11 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:41871) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iLdFs-0001qH-PT for bug-gnu-emacs@gnu.org; Fri, 18 Oct 2019 21:10:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iLdFr-0008Bx-Gg for bug-gnu-emacs@gnu.org; Fri, 18 Oct 2019 21:10:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:42906) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iLdFr-0008Bn-Dw for bug-gnu-emacs@gnu.org; Fri, 18 Oct 2019 21:10:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iLdFr-00021i-3q for bug-gnu-emacs@gnu.org; Fri, 18 Oct 2019 21:10:03 -0400 In-Reply-To: <21dc18b7-5951-431b-940b-ab7e56bf8226@default> Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Sat, 19 Oct 2019 01:10:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 31962 X-GNU-PR-Package: emacs Mail-Followup-To: 31962@debbugs.gnu.org, stefan@marxist.se, drew.adams@oracle.com Original-Received: via spool by 31962-done@debbugs.gnu.org id=D31962.15714473747743 (code D ref 31962); Sat, 19 Oct 2019 01:10:02 +0000 Original-Received: (at 31962-done) by debbugs.gnu.org; 19 Oct 2019 01:09:34 +0000 Original-Received: from localhost ([127.0.0.1]:51725 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iLdFN-00020p-Mm for submit@debbugs.gnu.org; Fri, 18 Oct 2019 21:09:33 -0400 Original-Received: from mail-pf1-f172.google.com ([209.85.210.172]:35825) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iLdFL-00020Z-CF for 31962-done@debbugs.gnu.org; Fri, 18 Oct 2019 21:09:31 -0400 Original-Received: by mail-pf1-f172.google.com with SMTP id 205so4866948pfw.2 for <31962-done@debbugs.gnu.org>; Fri, 18 Oct 2019 18:09:31 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to:cc; bh=m5c4UzU75F8MMAalYmAYA3Mxj4AM91cW/VukXIH1oaw=; b=Xn4FI/Zbuf9mr07b5ooaOSAewoEB/qaVTbCAA3OlOfer4ORrdp/v1LZaU5d+uTeEOc 2h+4bfa3LOtpqG7ej2R27dTGH1kgRPf69INCvUDIJ8VLKab0WnyUNZ44NEjwzp8mFIiy INJqmYwrd5tMmCWXLf2F9tTJ9jrEMuXj3NypfCu8AScTe5FbXEib+nbG3UEylB11Gj8f GV3GDOOY1qyubcpQkbHKbN0M37sT2F8Yg2V+lz4TgTG0KaEexejJDMzuTd+LvoiKBqAv hkgvVPJyCTg2OXnMESEwv2u05hFtseK5Z05Ak/RKswyWH4cp7i5+oVy5YnH3XgMb8HMp 9JAw== X-Gm-Message-State: APjAAAX9oB7OqOG194yQWMbh4QFKgrIGLwYLbcvKq3/v/RGHCLCcE5RF SXEhMu3Cs9TfgZJit4df1pAZnXXGMa8ghK/R5qg= X-Google-Smtp-Source: APXvYqxkXV/gIghsQT/J1WB1nLb4Zy+W0nn91189RwSJB+0BPF12XY7lpug3mLI4dmI+Prf1UxMZ9SYbpdAyvaXftOE= X-Received: by 2002:a62:1bd3:: with SMTP id b202mr9872003pfb.50.1571447365095; Fri, 18 Oct 2019 18:09:25 -0700 (PDT) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.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: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:169689 Archived-At: Eli Zaretskii writes: >> Date: Sun, 24 Jun 2018 18:51:23 -0700 (PDT) >> From: Drew Adams >> >> 1. `imenu--generic-function' should not have a double-hyphen in its >> name. It is the main function in the library, and it is explicitly >> referenced by multiple doc strings in the file > > As long as this function is not autoloaded, we have no unequivocal > proof that it's the main function in the library. A function that is > the workhorse of a library can legitimately be an internal function. > > I agree that this case is somewhat borderline, but I don't have enough > time and energy to make the changes in the current system, because the > problems it creates sound very minor to me. > > I made small fixes in 2 doc strings, but that's as far as I was > prepared to go in this case. > >> including that of a user option >> (`imenu-generic-skip-comments-and-strings') and that of the >> principal configuration variable (`imenu-generic-expression'), which >> is defined per mode. > > The doc string of imenu-generic-skip-comments-and-strings was one of > those I changed. > >> 2. The doc string of `imenu--generic-function' says this, with zero >> description of INDEX-NAME INDEX-POSITION FUNCTION and ARGUMENTS: >> >> The return value is an alist of the form >> (INDEX-NAME . INDEX-POSITION) >> or >> (INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...) >> The return value may also consist of nested index alists like: >> (INDEX-NAME . INDEX-ALIST) >> depending on PATTERNS. >> >> Each of those pieces of the return value should be specified, not just >> named. > > Not as long as this is an internal function. > >> 3. Similarly, other functions and variables should be renamed to use a >> single, not a double, hyphen, starting with `imenu--sort-by-name' and >> `imenu--index-alist'. I don't argue now that NO functions wnd variables >> in the library should have names declaring that they are internal, but a >> better judgment call is in order. > > Likewise. It looks like Eli made the necessary changes above, and I see nothing more to do here. I'm therefore closing this bug report. Please reopen if that's incorrect. Best regards, Stefan Kangas