From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#69305: outline-minor-mode for tabulated-list-mode Date: Tue, 27 Feb 2024 20:44:40 +0200 Message-ID: <86le75u4pz.fsf@gnu.org> References: <86msrtvi06.fsf@mail.linkov.net> <86frxlmy1d.fsf@gnu.org> <86cyspt02f.fsf@mail.linkov.net> <861q94nc4j.fsf@gnu.org> <867ciws983.fsf@mail.linkov.net> <86plwo1fii.fsf@gnu.org> <86il2fwuc8.fsf@mail.linkov.net> <86edd31tv5.fsf@gnu.org> <86jzmtda1y.fsf@mail.linkov.net> <86sf1hybm3.fsf@gnu.org> <86msrpx91u.fsf@mail.linkov.net> <86frxgwdzk.fsf@gnu.org> <86jzmqgxvg.fsf@mail.linkov.net> <861q8yux46.fsf@gnu.org> <86plwhg5o5.fsf@mail.linkov.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20333"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 69305@debbugs.gnu.org To: Juri Linkov Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Feb 27 19:56:15 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rf2cg-0004xw-Ho for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 27 Feb 2024 19:56:14 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rf2c6-0008AN-9Q; Tue, 27 Feb 2024 13:55:38 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rf2c3-00089Z-Ve for bug-gnu-emacs@gnu.org; Tue, 27 Feb 2024 13:55:36 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rf2c3-0002hN-NG for bug-gnu-emacs@gnu.org; Tue, 27 Feb 2024 13:55:35 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rf2cT-0005cO-NU for bug-gnu-emacs@gnu.org; Tue, 27 Feb 2024 13:56:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 27 Feb 2024 18:56:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69305 X-GNU-PR-Package: emacs Original-Received: via spool by 69305-submit@debbugs.gnu.org id=B69305.170906012121496 (code B ref 69305); Tue, 27 Feb 2024 18:56:01 +0000 Original-Received: (at 69305) by debbugs.gnu.org; 27 Feb 2024 18:55:21 +0000 Original-Received: from localhost ([127.0.0.1]:45846 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rf2bo-0005aY-Sv for submit@debbugs.gnu.org; Tue, 27 Feb 2024 13:55:21 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:60630) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rf2S2-00051v-KT for 69305@debbugs.gnu.org; Tue, 27 Feb 2024 13:45:16 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rf2RW-0000Sz-Tm; Tue, 27 Feb 2024 13:44:42 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=8fwlnlO4PB15F5s0RpfvXgvcGi14wZh32e4BVkxrT64=; b=QxGr7U0R1rkg u3804qCyZmYeVPciGDAa9XSxSNa00SAJhHtPUCi1uzOvpgKUbrZv65Al+vzbpZl6fh+kHyMvHNQxn Cr7b9ur2u6nJaBfHcubrhe8rCzuvJW06cNIPmy8UE9QjsBzDFrTecZgZ4vGllv6bUrMVoa1AjdWMN Rrrg/7a81lOcCKsablo0Ct8he/LYTG4QtFjCYFy3IzKV/GMBLZ8y6jSbDFI92aFbwvp7IDzT54QaM NvVU/CpnuSsQtdEP4vQdEBNgwQjc8XF0FcSi7gyHhy5DSWLpc0Z9vQm13ZCom/iNdKolzSkxagPQv OZzyQmy4I/i4RcukGf45xQ==; In-Reply-To: <86plwhg5o5.fsf@mail.linkov.net> (message from Juri Linkov on Tue, 27 Feb 2024 19:40:10 +0200) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:280738 Archived-At: > From: Juri Linkov > Cc: 69305@debbugs.gnu.org > Date: Tue, 27 Feb 2024 19:40:10 +0200 > > >> But tabulated-list-groups is not a defcustom. > >> There are no defcustoms here. > > > > Buffer-menu-group-by _is_ a defcustom, and it is documented thusly: > > > > + "If non-nil, buffers are grouped by function. > > +This function takes one argument: a list of entries in the same format > > +as in `tabulated-list-entries', and should return a list in the format > > +suitable for `tabulated-list-groups'. > > > > So you are inviting users to write functions that return values of a > > certain format, but the format's documentation IMO doesn't make it > > clear how to specify a grouping, and for its important part alludes to > > another variable (tabulated-list-entries), whose documentation is > > suitable for different kind of uses, not for grouping of entries. > > The format 'tabulated-list-entries' is input. > The format 'tabulated-list-groups' is output. Yes, I'm well aware of that. > > Since tabulated-list-groups is such an important part of the > > documentation of Buffer-menu-group-by, the doc string of > > tabulated-list-groups is in effect part of the doc string of > > Buffer-menu-group-by, and should IMO be worded as appropriate for user > > options. > > The docstring of 'tabulated-list-groups' already > sufficiently documents the format: No, it doesn't document it sufficiently. As I already said several times. > (defvar-local tabulated-list-groups nil > "Groups displayed in the current Tabulated List buffer. > This should be either a function, or a list. > If a list, each element has the form (GROUP-NAME ENTRIES), > where: > > - GROUP-NAME is a group name as a string, which is displayed > at the top line of each group. > > - ENTRIES is a list described in `tabulated-list-entries'. > > There is no need to duplicate the description of linked > 'tabulated-list-entries'. This is not about duplication. This is about adding information that currently isn't there. > And here it's clear that the function should add GROUP-NAME to > groups from 'tabulated-list-entries'. Which doesn't clarify the issue at hand even a single bit.