From debbugs-submit-bounces@debbugs.gnu.org Thu Jul 16 05:05:53 2015 Received: (at submit) by debbugs.gnu.org; 16 Jul 2015 09:05:53 +0000 Received: from localhost ([127.0.0.1]:50632 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZFf72-00035F-My for submit@debbugs.gnu.org; Thu, 16 Jul 2015 05:05:53 -0400 Received: from eggs.gnu.org ([208.118.235.92]:54082) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZFf70-000350-6s for submit@debbugs.gnu.org; Thu, 16 Jul 2015 05:05:50 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZFf6t-0006o0-GX for submit@debbugs.gnu.org; Thu, 16 Jul 2015 05:05:44 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:35364) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZFf6t-0006nv-DQ for submit@debbugs.gnu.org; Thu, 16 Jul 2015 05:05:43 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:39336) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZFf6r-0007PA-Mv for bug-gnu-emacs@gnu.org; Thu, 16 Jul 2015 05:05:43 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZFf6n-0006mT-CI for bug-gnu-emacs@gnu.org; Thu, 16 Jul 2015 05:05:41 -0400 Received: from mail.mojserwer.eu ([195.110.48.8]:35122) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZFf6n-0006lk-5T for bug-gnu-emacs@gnu.org; Thu, 16 Jul 2015 05:05:37 -0400 Received: from localhost (localhost [127.0.0.1]) by mail.mojserwer.eu (Postfix) with ESMTP id 2887C512018 for ; Thu, 16 Jul 2015 11:05:35 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at mail.mojserwer.eu Received: from mail.mojserwer.eu ([127.0.0.1]) by localhost (mail.mojserwer.eu [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id CdCIzIE-d4Zh for ; Thu, 16 Jul 2015 11:05:31 +0200 (CEST) Received: from localhost (unknown [109.232.24.146]) by mail.mojserwer.eu (Postfix) with ESMTPSA id 82741512011 for ; Thu, 16 Jul 2015 11:05:31 +0200 (CEST) From: Marcin Borkowski To: bug-gnu-emacs@gnu.org Subject: 25.0.50; Incomplete docs for tabulated-list-mode Date: Thu, 16 Jul 2015 11:05:22 +0200 Message-ID: <87a8uwmq0d.fsf@mbork.pl> MIME-Version: 1.0 Content-Type: text/plain X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2001:4830:134:3::11 X-Spam-Score: -5.0 (-----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.0 (-----) Hello, I'd like to report a bug in the documentation: the functions `tabulated-list-get-id' and `tabulated-list-get-entry' are not mentioned in the manual (Emacs version info below). In GNU Emacs 25.0.50.1 (i686-pc-linux-gnu, GTK+ Version 3.10.8) of 2015-01-02 on aga-netbook Repository revision: 11ee7d8bf16b8ee4fcb3659e4b09686ed8b10590 Windowing system distributor `The X.Org Foundation', version 11.0.11501000 System Description: Ubuntu 14.04.2 LTS Best regards, -- Marcin Borkowski http://octd.wmi.amu.edu.pl/en/Marcin_Borkowski Faculty of Mathematics and Computer Science Adam Mickiewicz University From debbugs-submit-bounces@debbugs.gnu.org Tue Jan 15 13:19:25 2019 Received: (at 21074) by debbugs.gnu.org; 15 Jan 2019 18:19:25 +0000 Received: from localhost ([127.0.0.1]:60350 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gjTJ6-0001kp-O4 for submit@debbugs.gnu.org; Tue, 15 Jan 2019 13:19:25 -0500 Received: from mail-oi1-f195.google.com ([209.85.167.195]:43896) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gjTJ3-0001kY-Ec for 21074@debbugs.gnu.org; Tue, 15 Jan 2019 13:19:23 -0500 Received: by mail-oi1-f195.google.com with SMTP id u18so2867061oie.10 for <21074@debbugs.gnu.org>; Tue, 15 Jan 2019 10:19:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=user-agent:from:to:subject:date:message-id:mime-version; bh=o7JWkDwA5p0nRdSfFvLGjWAhxOeKxeQqKY6tSlKKJgc=; b=vCDTusX+9y4zsivIuTz3rOUERzFk3XBCUzzNvLxKIM+pP6py6qexUwTk9QCyrgcsh5 0JktvyhcLZfHAvx97ofqyIDQIJrV+PreTPd6X48dvGoqC0qFos4zIv6TenjeRh7mX5A6 HEXA7xzBWPqknMwb5TLa6R1ILeNxc0yJC1hBeO5f67V3akRw/RoHW2DvtK5Oq1L6w9Ir Kwp+cpzD63LqB4CX66Qs3Tu4/9WVj35jVFs3RO/Gql/Z7ylLL3RpBtGUlmSTEqpdYa4a Y+pmuWwB6yY82BQRL6Ah3RkoBd//b01Y4K0Kf9yX+yrSFnxEQ6+324Skdu9vv6Fw++B6 uJjQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:user-agent:from:to:subject:date:message-id :mime-version; bh=o7JWkDwA5p0nRdSfFvLGjWAhxOeKxeQqKY6tSlKKJgc=; b=Gp/rXrqXGO0osrKhJSKg9Tc/w8kB+WfumRVHOitvwlJ9sz+kKie1rpxfba6WOaipsY veolqYfY4BpQsSErE/FK7tKmK8ImK8bl5oQtOmNQl6mxOJyTMD7zeogagkmIAvqfKnww bpUkPMytGcZh6KG8ZcbbVambLZwqw3S2uJyY5Tl7x9RdLilUcKl+zovlvuOU1mQGT9ph JIDLd+RhRmxHXkQvzcRTAjvuyHJgRZYIJO6Euf1U4xfyCWNBZA4kJU1fnZhwVOnG3RSt JBt0m6J7N0PU/X3oW9dJoi7156zwlOQA6DpYUsgscYUYUSfRZD1cqmMw9lTHBmETG4mN rXIQ== X-Gm-Message-State: AJcUuke/VEpMAMvpa0b3WQN05VWMPx9GOLcEJY9LU0xmgMLNvXIxOixe 7yJRsnE/xGHfd01l3VNk3aUrhSZ0 X-Google-Smtp-Source: ALg8bN5VQiCJnFtMTmdLbRn28GBsp1Lm1G2yCAZJJY0fXrXmh8oBCw5fmCmCiSfVYLdNtBLXbJx2tg== X-Received: by 2002:aca:bb8b:: with SMTP id l133mr1448473oif.357.1547576355352; Tue, 15 Jan 2019 10:19:15 -0800 (PST) Received: from earth (cpe-70-114-192-208.austin.res.rr.com. [70.114.192.208]) by smtp.gmail.com with ESMTPSA id q128sm1826942oia.4.2019.01.15.10.19.13 for <21074@debbugs.gnu.org> (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 15 Jan 2019 10:19:14 -0800 (PST) User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: 21074@debbugs.gnu.org Subject: [PATCH] Add docs for two tabulated-list functions Date: Tue, 15 Jan 2019 12:19:13 -0600 Message-ID: <871s5diy1q.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain Hello - This patch adds documentation for tabulated-list-get-{id, entry} to doc/lispref/modes.texi. Thanks, Alex >From 00a4e4ef99099d5c7f597a07c374a7e679cbe851 Mon Sep 17 00:00:00 2001 From: Alex Branham Date: Tue, 15 Jan 2019 12:15:44 -0600 Subject: [PATCH] Add documentation to lispref for two tabulated-list functions * doc/lispref/modes.texi (Tabulated List Mode): Add documentation for functions 'tabulated-list-get-id' and 'tabulated-list-get-entry'. Bug #21074 --- doc/lispref/modes.texi | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 143cc7c582..219aa504f8 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1121,6 +1121,20 @@ Tabulated List Mode from entries that haven't changed (normally all tags are removed). @end defun +@defun tabulated-list-get-id &optional pos +This function returns the entry ID of the entry at @var{pos}, which +defaults to point if omitted or @code{nil}. This will be an ID object +from @var{tabulated-list-entries}. +@end defun + +@defun tabulated-list-get-entry &optional pos +This function returns the entry at @var{pos}, which defaults to point +if omitted or @code{nil}. This will be a vector for the ID at +@var{pos} from @var{tabulated-list-entries}. If there is no entry at +@var{pos}, then the function returns @code{nil}. +@end defun + + @node Generic Modes @subsection Generic Modes @cindex generic mode -- 2.19.2 --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Add-documentation-to-lispref-for-two-tabulated-list-.patch >From 00a4e4ef99099d5c7f597a07c374a7e679cbe851 Mon Sep 17 00:00:00 2001 From: Alex Branham Date: Tue, 15 Jan 2019 12:15:44 -0600 Subject: [PATCH] Add documentation to lispref for two tabulated-list functions * doc/lispref/modes.texi (Tabulated List Mode): Add documentation for functions 'tabulated-list-get-id' and 'tabulated-list-get-entry'. Bug #21074 --- doc/lispref/modes.texi | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 143cc7c582..219aa504f8 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1121,6 +1121,20 @@ Tabulated List Mode from entries that haven't changed (normally all tags are removed). @end defun +@defun tabulated-list-get-id &optional pos +This function returns the entry ID of the entry at @var{pos}, which +defaults to point if omitted or @code{nil}. This will be an ID object +from @var{tabulated-list-entries}. +@end defun + +@defun tabulated-list-get-entry &optional pos +This function returns the entry at @var{pos}, which defaults to point +if omitted or @code{nil}. This will be a vector for the ID at +@var{pos} from @var{tabulated-list-entries}. If there is no entry at +@var{pos}, then the function returns @code{nil}. +@end defun + + @node Generic Modes @subsection Generic Modes @cindex generic mode -- 2.19.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Tue Jan 15 14:06:44 2019 Received: (at 21074) by debbugs.gnu.org; 15 Jan 2019 19:06:44 +0000 Received: from localhost ([127.0.0.1]:60375 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gjU2u-0002to-MK for submit@debbugs.gnu.org; Tue, 15 Jan 2019 14:06:44 -0500 Received: from eggs.gnu.org ([209.51.188.92]:47886) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gjU2t-0002tc-B9 for 21074@debbugs.gnu.org; Tue, 15 Jan 2019 14:06:43 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:51665) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gjU2c-0004DI-9n; Tue, 15 Jan 2019 14:06:30 -0500 Received: from [176.228.60.248] (port=2470 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gjU2a-00039W-Eb; Tue, 15 Jan 2019 14:06:26 -0500 Date: Tue, 15 Jan 2019 21:06:14 +0200 Message-Id: <83won5d9ll.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham In-reply-to: <871s5diy1q.fsf@gmail.com> (message from Alex Branham on Tue, 15 Jan 2019 12:19:13 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Date: Tue, 15 Jan 2019 12:19:13 -0600 > > This patch adds documentation for tabulated-list-get-{id, entry} to > doc/lispref/modes.texi. Thanks, but what is the rationale for adding these two, specifically? From debbugs-submit-bounces@debbugs.gnu.org Tue Jan 15 14:41:39 2019 Received: (at 21074) by debbugs.gnu.org; 15 Jan 2019 19:41:39 +0000 Received: from localhost ([127.0.0.1]:60391 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gjUah-0003ld-2b for submit@debbugs.gnu.org; Tue, 15 Jan 2019 14:41:39 -0500 Received: from mail-ot1-f52.google.com ([209.85.210.52]:33153) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gjUae-0003lP-22 for 21074@debbugs.gnu.org; Tue, 15 Jan 2019 14:41:37 -0500 Received: by mail-ot1-f52.google.com with SMTP id i20so3681844otl.0 for <21074@debbugs.gnu.org>; Tue, 15 Jan 2019 11:41:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=XLnNF22JRSvGOegMW+g/jucFOgFLfR0rdzNFCZyF2VE=; b=hubf0NiG3yWqqEanXN8Kz14uAts+qkh3Sju9aXewA7Ys5hLGMk317+RC1/lhoGPv6d 26LtFRlzlTvGMb7Hc1AXE0+E1NJ2NhIzqFBnTfLRUKiXHKQDxWqnNWpsThlfSmmRmMwM z4MKHrvoLxNzfw0pPZSH+vOhbZzsvJLaEjFeRhGjW+MSx7DVWGAt5Xt8SmLkg3PI8Gn7 vgVciWgY0+ElDva4V+HUUob2LJoJGgjGSw+CWhrNHTStOYgNB08drkG7CjbtM3dYoUFO cOw44Sp4c3eqFohPLzAtXW0hwCi8KLSkxn39BAmwGnlRg4NGap0LInQlkDPx8+FCbTB0 H0lQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=XLnNF22JRSvGOegMW+g/jucFOgFLfR0rdzNFCZyF2VE=; b=ejKimSq6biqi54QikC1CV/whIafFJNb/9iu0vZpgInpe/AJndX42JwMw3q/SJErBx7 1Pdp4OkLwm0ZuimO0cmTwYNfyLvHGXt+UDoIeGTZTBSSHWY58ZYMdFQeobyPG/FNgWcX Sl8T5UXJTUmAl9M6fQTZAs1RDpUR3F9JR/GmP8EZG1LXCsjbZ3r2MVjgNdzIOyythDLq 1jxYwHQpgGCWKpU7LQnYENf2XgFiYFs/CL6fZrbHEYZiYCW/RosVWU72L+C0l7rJZBa1 ng4ZSLazBV4jum2r6YNJwJmL1Tp24Wb/WkKLQ2Kjxf3pq7dyKavPdlNRv3RHCcv9xj+d eV0g== X-Gm-Message-State: AJcUukePWOBvrj8DR1IAWhY9cGIu3e8RUO7VkBzVKcrTho+zDoJvCilU KiLZ2tejVFEPWdx3MlZ1H9r2tBo5 X-Google-Smtp-Source: ALg8bN7UNAv0+pJc+8/oBFR2V6QT/a9agTF0Qm+TXPa8Bw4nhlzuVvDSYJIcFSbQiYxf+XPJOOBgXQ== X-Received: by 2002:a9d:2666:: with SMTP id a93mr3139420otb.235.1547581289986; Tue, 15 Jan 2019 11:41:29 -0800 (PST) Received: from earth (cpe-70-114-192-208.austin.res.rr.com. [70.114.192.208]) by smtp.gmail.com with ESMTPSA id h16sm1696420otl.29.2019.01.15.11.41.29 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 15 Jan 2019 11:41:29 -0800 (PST) References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: Eli Zaretskii Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions In-reply-to: <83won5d9ll.fsf@gnu.org> Date: Tue, 15 Jan 2019 13:41:28 -0600 Message-ID: <87zhs1hfo7.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain On Tue 15 Jan 2019 at 13:06, Eli Zaretskii wrote: >> From: Alex Branham >> Date: Tue, 15 Jan 2019 12:19:13 -0600 >> >> This patch adds documentation for tabulated-list-get-{id, entry} to >> doc/lispref/modes.texi. > > Thanks, but what is the rationale for adding these two, specifically? I was surprised to see they weren't in there the other day when I was playing around with tabulated-list-mode. "How do I get the ID of the entry at point" is a pretty common question, I'd guess. Since I saw this bug on the bug tracker today I figured I'd submit a patch. If it doesn't belong in the manual feel free to ignore the patch (but then this bug should probably be closed). Thanks, Alex --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEEeEJ4XAMgliXNXicpHkInolPpmscFAlw+N2gACgkQHkInolPp mse1GggAxMbmBeZIfsDyxQkIzL2RBKW3vW4FtYVnzGSK/uw+h8GS9QGmbgQmrEcz +6QdxgUm4RPBu5k0uuHu/0nqcvM3dpr0llK9yD4yZwhiRUFuQRBihJgNfUM//LqU Z7cw3VmWFeKIFaRAteeM7uRVEJ7cY1lt46U/YDmx36e5B92n6olEfQZp4m4mqZQ2 /tgH9OrA3GfLReIt2xH0aQ+2v498KHdaTv2ST2dX5n6+8VC0m2yy5hGyt8rHTwRs UC2NsTfZvSPI65YKEMRScF/zmEUYzBWIvqWxkgrCOdluZ/VpacKA4a+PF9rKhjnX Lsa9GI0DR0E5GYX2Xz+cmMKCtD4E/Q== =sB58 -----END PGP SIGNATURE----- --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Sat Jan 19 03:25:44 2019 Received: (at 21074) by debbugs.gnu.org; 19 Jan 2019 08:25:45 +0000 Received: from localhost ([127.0.0.1]:37280 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gklwm-0002Ae-K7 for submit@debbugs.gnu.org; Sat, 19 Jan 2019 03:25:44 -0500 Received: from eggs.gnu.org ([209.51.188.92]:55055) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gklwk-0002AQ-5j for 21074@debbugs.gnu.org; Sat, 19 Jan 2019 03:25:42 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:58450) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gklwd-0003uv-2p; Sat, 19 Jan 2019 03:25:35 -0500 Received: from [176.228.60.248] (port=4595 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gklwb-0007lH-M5; Sat, 19 Jan 2019 03:25:34 -0500 Date: Sat, 19 Jan 2019 10:25:13 +0200 Message-Id: <83k1j1awba.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham , Marcin Borkowski In-reply-to: <87zhs1hfo7.fsf@gmail.com> (message from Alex Branham on Tue, 15 Jan 2019 13:41:28 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Cc: 21074@debbugs.gnu.org > Date: Tue, 15 Jan 2019 13:41:28 -0600 > > On Tue 15 Jan 2019 at 13:06, Eli Zaretskii wrote: > > >> From: Alex Branham > >> Date: Tue, 15 Jan 2019 12:19:13 -0600 > >> > >> This patch adds documentation for tabulated-list-get-{id, entry} to > >> doc/lispref/modes.texi. > > > > Thanks, but what is the rationale for adding these two, specifically? > > I was surprised to see they weren't in there the other day when I was > playing around with tabulated-list-mode. "How do I get the ID of the > entry at point" is a pretty common question, I'd guess. Since I saw this > bug on the bug tracker today I figured I'd submit a patch. If it doesn't > belong in the manual feel free to ignore the patch (but then this bug > should probably be closed). Ah, I wasn't aware there was a previous context for this bug. (Please in the future say something to put things in their context, otherwise one needs to deduce from the bug number that it might have been discussed previously, and go look up that discussion. I usually just ignore the bug number.) After looking into this for some time, I think we should document functions of tabulated-mode that are frequently used by its clients, of which there are some in the Emacs tree. The above 2 functions aren't the only ones undocumented in the manual. So either we document them all, or we'd need more serious rationale for documenting just those 2. Would you like to see what other tabulated-mode functions are candidates for addition to the manual? In any case, a few minor comments for the patch: > +@defun tabulated-list-get-id &optional pos In the code, this is a defsubst, not a defun. > +This function returns the entry ID of the entry at @var{pos}, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Just "... returns the ID of the entry" is more clear and concise. > + which > +defaults to point if omitted or @code{nil}. This "which" makes the text ambiguous: it could refer to the ID or to POS. So I suggest to write a separate sentence: If omitted or @code{nil}, @var{pos} defaults to position of point. > + This will be an ID object > +from @var{tabulated-list-entries}. An element of tabulated-list-entries could be a function, and what does this return in that case? This should be spelled out in the manual, otherwise the reader will be left out wondering. > +@defun tabulated-list-get-entry &optional pos > +This function returns the entry at @var{pos}, which defaults to point > +if omitted or @code{nil}. This will be a vector for the ID at > +@var{pos} from @var{tabulated-list-entries} This is not detailed enough. E.g., it says nothing about what will be the elements of the vector. The doc string is more detailed, but it is too terse, and the manual should expand on that. The description should also make clear what happens if the corresponding element of tabulated-list-entries is a function. > + . If there is no entry at ^^ Two spaces between sentences, please. Thanks. From debbugs-submit-bounces@debbugs.gnu.org Mon Jan 21 11:12:33 2019 Received: (at 21074) by debbugs.gnu.org; 21 Jan 2019 16:12:33 +0000 Received: from localhost ([127.0.0.1]:40362 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1glcBd-0001KZ-7K for submit@debbugs.gnu.org; Mon, 21 Jan 2019 11:12:33 -0500 Received: from mail-ot1-f43.google.com ([209.85.210.43]:40893) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1glcBa-0001KM-LQ for 21074@debbugs.gnu.org; Mon, 21 Jan 2019 11:12:32 -0500 Received: by mail-ot1-f43.google.com with SMTP id s5so20965089oth.7 for <21074@debbugs.gnu.org>; Mon, 21 Jan 2019 08:12:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=aYbtx80/6969HibyEhdJLmI4Q5GI1Jzp+BbN/U33CXg=; b=FQPRbExP9zDQBbczOwdT7lUYbLrRlKrORdRHUxcSZIAf0MWf4MnXh57jIxcMaMLpNL gV9H25w7HlR8ZFNIiBTqRYTUGS5DUsR2WZsuFr9P9YB5YULEF1BzTgEhiNzn+en3Lk2k M6boGdeGuBkQkD4TzAdk3SxVAdUDMli4BQMSu0fvEPbTJrG+VTdbVTJEL/Vfz8HuUskP EcyA1H+8KxI2U4b02ZAYkeKAdjCSmhYY7r6v1cn/hdq701oMEoWqnKW/jhcwNS7E5Cts +RmcCcTW2gx/+qsUNzocJXbaNL8BZ6U1htikz+k8v2IW1CjhvgDS57V1OWM6dgLJ7U/k ICfg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=aYbtx80/6969HibyEhdJLmI4Q5GI1Jzp+BbN/U33CXg=; b=oaSwC/1LH7YqGUcDg9+OB5BNr7mjzBWnsLvzckDuLMc+qB7MPOmkk3009Dkb+20yUh Al37cVKBdew5t0cPSPg0VHGiCAw+RGgc5LFEJZBT75uik5RYx9r/QPVAbQEgP3WGtsoE 5E9N8JrVqXtHa7DjnkZR3rySU7aUzeNXKFXYaw8fStzdIMHlIAxbOirEB7S5l/Dp+WBF e03HucS5m+hG0CNHOJ9rXy33/7bz61Dw3wqJ6IvEzIEIjUd1sUgr9fB+2tyiEBel/uiP HeO1v520PUBlU/WpMcdvTzIjASA3oeLZ4rTEyA0W355fnyrIoDLMkWtWx0arbKRfUnDv bhgQ== X-Gm-Message-State: AJcUukfHdHMf0uZoO4Frpn/IvH6nqkzgZGmFvRM0PNCiZeQJcqJIwxC1 h/cItSalKVRh8aJd5Pmx3bxeyVog X-Google-Smtp-Source: ALg8bN7CWd8H8dOBg9Z3hIs7P4F/bFW+dc+lmEuG24sKqQp2H8YyrPAPnHYY7QpVqwRHgn7GnBAN0g== X-Received: by 2002:a9d:4a87:: with SMTP id i7mr20287480otf.178.1548087144657; Mon, 21 Jan 2019 08:12:24 -0800 (PST) Received: from mars (cpe-70-114-192-208.austin.res.rr.com. [70.114.192.208]) by smtp.gmail.com with ESMTPSA id i12sm5482091otc.48.2019.01.21.08.12.23 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 21 Jan 2019 08:12:23 -0800 (PST) References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: Eli Zaretskii Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions In-reply-to: <83k1j1awba.fsf@gnu.org> Date: Mon, 21 Jan 2019 10:12:22 -0600 Message-ID: <875zuic7mh.fsf@gmail.com> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, Marcin Borkowski X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) On Sat 19 Jan 2019 at 02:25, Eli Zaretskii wrote: > Ah, I wasn't aware there was a previous context for this bug. (Please > in the future say something to put things in their context, otherwise > one needs to deduce from the bug number that it might have been > discussed previously, and go look up that discussion. I usually just > ignore the bug number.) Will do, sorry. I'm still trying to find a good way to interact with the bugtracker. > After looking into this for some time, I think we should document > functions of tabulated-mode that are frequently used by its clients, > of which there are some in the Emacs tree. The above 2 functions > aren't the only ones undocumented in the manual. So either we > document them all, or we'd need more serious rationale for documenting > just those 2. Would you like to see what other tabulated-mode > functions are candidates for addition to the manual? I'm not sure there's a great way to decide what needs documentation and what doesn't. Glancing through the code in the Emacs tree, these are the functions that seem to get used fairly often by modes that derive from tabulated-list-mode: - tabulated-list-delete-entry - tabulated-list-get-entry - tabulated-list-get-id - tabulated-list-header-overlay-p - tabulated-list-put-tag - tabulated-list-set-col So perhaps start with those? I got the rest of your comments (thanks!) and will incorporate them into a follow-up patch once we decide what exactly needs to get documented. Alex From debbugs-submit-bounces@debbugs.gnu.org Mon Jan 21 11:33:13 2019 Received: (at 21074) by debbugs.gnu.org; 21 Jan 2019 16:33:13 +0000 Received: from localhost ([127.0.0.1]:40377 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1glcVc-0001qb-Ng for submit@debbugs.gnu.org; Mon, 21 Jan 2019 11:33:12 -0500 Received: from eggs.gnu.org ([209.51.188.92]:49774) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1glcVZ-0001qM-SW for 21074@debbugs.gnu.org; Mon, 21 Jan 2019 11:33:10 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:40431) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1glcVU-0007iw-Ap; Mon, 21 Jan 2019 11:33:04 -0500 Received: from [176.228.60.248] (port=2280 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1glcVT-00083o-VT; Mon, 21 Jan 2019 11:33:04 -0500 Date: Mon, 21 Jan 2019 18:32:50 +0200 Message-Id: <83munu9djh.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham In-reply-to: <875zuic7mh.fsf@gmail.com> (message from Alex Branham on Mon, 21 Jan 2019 10:12:22 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <875zuic7mh.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Cc: Marcin Borkowski , 21074@debbugs.gnu.org > Date: Mon, 21 Jan 2019 10:12:22 -0600 > > I'm not sure there's a great way to decide what needs documentation and > what doesn't. Glancing through the code in the Emacs tree, these are the > functions that seem to get used fairly often by modes that derive from > tabulated-list-mode: > > - tabulated-list-delete-entry > - tabulated-list-get-entry > - tabulated-list-get-id > - tabulated-list-header-overlay-p > - tabulated-list-put-tag > - tabulated-list-set-col > > So perhaps start with those? Yes, I think so. > I got the rest of your comments (thanks!) and will incorporate them into > a follow-up patch once we decide what exactly needs to get documented. Thanks. From debbugs-submit-bounces@debbugs.gnu.org Tue Jan 22 16:03:53 2019 Received: (at 21074) by debbugs.gnu.org; 22 Jan 2019 21:03:53 +0000 Received: from localhost ([127.0.0.1]:41618 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gm3D7-0007Tw-C7 for submit@debbugs.gnu.org; Tue, 22 Jan 2019 16:03:53 -0500 Received: from mail-oi1-f171.google.com ([209.85.167.171]:41049) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gm3D4-0007Tj-A5 for 21074@debbugs.gnu.org; Tue, 22 Jan 2019 16:03:50 -0500 Received: by mail-oi1-f171.google.com with SMTP id j21so18646516oii.8 for <21074@debbugs.gnu.org>; Tue, 22 Jan 2019 13:03:50 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=4nvqRz94UWksiyp15lM4jdMl9wmtLzK95Ll/wqKK+yY=; b=VFPkDT0V/5udDjPbhmwmk5Jvoz2MZt13Lwv/Y6C6tOxoye+m1+blXttiN6FQKLGZLk ExvmAxHpLeJjUA9aq/786OWdrSuKAe8+EX5wXn4WLM/heXX4uBiFwCoMdS702cbdQ1vo r6LmcqirVEvpRZH9nrRr05hsnXv546r5psrHbdrQxxPyT8wHu/f7Wn4SfpbIENRA/Y4P BcRN4z8AdhvnBf+PVJVISdWnmCA6qGip36iSuRY+/Q1DvjkE9/GH+CRsISeaMpFisGXJ ZQOMZO/nkVOCdrUlunNV4zJCe3cqml6br2ANBWImKbufpGFPp4/rp+HIKiRqYtjFnMAU wOfQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=4nvqRz94UWksiyp15lM4jdMl9wmtLzK95Ll/wqKK+yY=; b=iyVRx6mQlBzbTYr9F8XQ+MeUoUr6UsRIh3Gg5MVprjxv0xpBDTy9W7bu/Hsx2QKEB2 54cscK/PR6wYacvnOqpvezudNP8TNGCo37CuP//zLC/DR6QDOQ9mS9gX6061anBh6hwz uVfdj1vVtdqnggtssfykj7QUok/4lmvY/RGh1LNcncaffJiRv8arcE5gM3hsSFucTyjE SONI7XLB1B2lyJ23BdGMqx6b1K8PI5xij2sqRd+mME9OFRhyz+XrCAvpCX9Kmi5jlRc4 RT3/xNzKelTEtJI6RWLtRAtvQpdH2TJyvFNIg6/cQ7lnt6ob4IJc0oayV5uDbMl8PHGE BeeA== X-Gm-Message-State: AJcUukcWaLJcc6cR3hP1ajqZHGCOeuMNMojgh6j+xasGZFq0bzClaTfJ HXNljat2WOuMrXNqJ8dIYPQl0nLA X-Google-Smtp-Source: ALg8bN6h9Dlwh88yIZRYAaQjceb/LxyVivUbxSrvyFXg749daUYDXtRxRQuaZ7XDGcSvyWVmUP+Yhw== X-Received: by 2002:aca:3c06:: with SMTP id j6mr9117090oia.126.1548191024326; Tue, 22 Jan 2019 13:03:44 -0800 (PST) Received: from mars (nat-128-62-58-163.public.utexas.edu. [128.62.58.163]) by smtp.gmail.com with ESMTPSA id b2sm7995957oia.8.2019.01.22.13.03.43 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 22 Jan 2019 13:03:43 -0800 (PST) References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: Eli Zaretskii Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions In-reply-to: <83k1j1awba.fsf@gnu.org> Date: Tue, 22 Jan 2019 15:03:41 -0600 Message-ID: <87k1iwl80i.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, Marcin Borkowski X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain Thanks Eli, I'm going through this now and just have a couple quick questions about your comments: On Sat 19 Jan 2019 at 02:25, Eli Zaretskii wrote: > In any case, a few minor comments for the patch: > >> +@defun tabulated-list-get-id &optional pos > > In the code, this is a defsubst, not a defun. How do we document these in the elisp manual? I'm struggling to find an example. Is it just: @findex{tabulated-list-get-id} tabulated-list-get-id &optional pod This function returns... ? >> + This will be an ID object >> +from @var{tabulated-list-entries}. > > An element of tabulated-list-entries could be a function, and what > does this return in that case? This should be spelled out in the > manual, otherwise the reader will be left out wondering. That's not my understanding. I think tabulated-list-entries can either be a list with elements that look like (id col), or be a function that returns that list. As I understand, elements of the list can't be functions. If that's correct, I think it's clear enough that the ID of the entry at point is determined by the function 'tabulated-list-entries' and we don't need to mention it (the wording gets complicated). If you still want to add it, perhaps something like: This will be an ID object from @var{tabulated-list-entries} or calculated from that function if @var{tabulated-list-entries} is a function. What do you think? Thanks, Alex --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEEeEJ4XAMgliXNXicpHkInolPpmscFAlxHhS0ACgkQHkInolPp msfVRAf/aoIZ+cquuwfuJ6/DZmEW+GfTPoYNuqY581CbV9zwo/wVUTTjy6jBD/eK OFio6zOIMcCM/MNfHV9f43FDjVKy5Hxkd/bVy1Jnb4VWCo6VxzYpGc8TO7u0gFXO oRed7fzjLQJAtxMQalfLiuvwsEKjDfOzTEFtfCuxdy+btNKJVg9RdXjsn/exin1U L7LozST0WnK6pw5DM7QCCBKEmERX8seQRhrJrxqJxBUFRbmeyt4ohtSZB7CIEsZR K3QvBFG8EI0eQ1QkQiCXVa+A7kVWSjcnwfbu8gYMnGNnJwNO6Buvwb34FRKsLSte 4ooEga909v2xx/Ofwv3LeqbhQ51Kkw== =LGtl -----END PGP SIGNATURE----- --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Fri Feb 01 04:28:30 2019 Received: (at 21074) by debbugs.gnu.org; 1 Feb 2019 09:28:30 +0000 Received: from localhost ([127.0.0.1]:53711 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpV7d-0005vV-VL for submit@debbugs.gnu.org; Fri, 01 Feb 2019 04:28:30 -0500 Received: from eggs.gnu.org ([209.51.188.92]:37350) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpV7b-0005vG-9L for 21074@debbugs.gnu.org; Fri, 01 Feb 2019 04:28:28 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:55096) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gpV7V-00038p-Fh; Fri, 01 Feb 2019 04:28:21 -0500 Received: from [176.228.60.248] (port=2850 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gpV7U-0008NK-Ta; Fri, 01 Feb 2019 04:28:21 -0500 Date: Fri, 01 Feb 2019 11:28:17 +0200 Message-Id: <83zhrfyi1a.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham In-reply-to: <87k1iwl80i.fsf@gmail.com> (message from Alex Branham on Tue, 22 Jan 2019 15:03:41 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Cc: Marcin Borkowski , 21074@debbugs.gnu.org > Date: Tue, 22 Jan 2019 15:03:41 -0600 > > >> +@defun tabulated-list-get-id &optional pos > > > > In the code, this is a defsubst, not a defun. > > How do we document these in the elisp manual? I'm struggling to find an > example. Is it just: > > @findex{tabulated-list-get-id} > tabulated-list-get-id &optional pod > > This function returns... > > ? I think just say in the description something like "This @code{defsubst} returns...". > > >> + This will be an ID object > >> +from @var{tabulated-list-entries}. > > > > An element of tabulated-list-entries could be a function, and what > > does this return in that case? This should be spelled out in the > > manual, otherwise the reader will be left out wondering. > > That's not my understanding. I think tabulated-list-entries can either > be a list with elements that look like (id col), or be a function that > returns that list. As I understand, elements of the list can't be > functions. If that's correct, I think it's clear enough that the ID of > the entry at point is determined by the function > 'tabulated-list-entries' and we don't need to mention it (the wording > gets complicated). If you still want to add it, perhaps something like: > > This will be an ID object from @var{tabulated-list-entries} or > calculated from that function if @var{tabulated-list-entries} is a > function. This is the ID object from @code{tabulated-list-entries} (if that is a list) or from the list returned by @code{tabulated-list-entries} (if it is a function). Note: @code, not @var, because tabulated-list-entries is a literal symbol, not an argument of a function. From debbugs-submit-bounces@debbugs.gnu.org Sat Feb 02 11:03:42 2019 Received: (at 21074) by debbugs.gnu.org; 2 Feb 2019 16:03:42 +0000 Received: from localhost ([127.0.0.1]:56526 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpxld-0006aC-Sj for submit@debbugs.gnu.org; Sat, 02 Feb 2019 11:03:42 -0500 Received: from mail-ot1-f49.google.com ([209.85.210.49]:34434) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpxlb-0006Zy-GI for 21074@debbugs.gnu.org; Sat, 02 Feb 2019 11:03:40 -0500 Received: by mail-ot1-f49.google.com with SMTP id t5so8744500otk.1 for <21074@debbugs.gnu.org>; Sat, 02 Feb 2019 08:03:39 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=p5IWSKq60/8iOSCdD3M61qsIYoWRi9oY8sh4uoeR6wI=; b=JXHeIkMFsQsmwNGbCdFfTNtyFgbDdmjy9gljj8dgqDyHBEu4fMu3UcH7nnZsOb3IZD SOQP4KGJV6MJ+J6vYH4iqY6fk01WH8WjO72RXaERHn2m8NuuZYL4BR+lJCmUyz2qZd4o 4XuqabmWSOd+993e6JWP8BAWYWmTK7qcOqYyA9P+K44xPi00c337Xtdy2DTStEyMbfFe eYku3ABylkHH2RR/ixq8ZxlCKGlbpIxxCj7kXz1+I8+b3syDA8y8XtMM5jEYeGXJ3tLk 6hvgAuSA6EYXnVpgYtloJca8wKW+5W/dejGLv3WeE+rGjDbmtl7iJb0mVBZE121xamnP uhEw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=p5IWSKq60/8iOSCdD3M61qsIYoWRi9oY8sh4uoeR6wI=; b=se8K+NnRTBEHgB7Im7YFfGPyF2kjCXlLO4ukOnNtUO2OLuadZ35vGvF2GRYxZKNgqC wzL4QFd53AdvGxlcRyjr10XuqOqFsdnUjTP6e7Wsr8Vgv8XxEpjEiOVPgvMRLNSi5obq iPW25FRQUzgGjePjOtphTgxjru02KeQ1RUYZGOqqrAGYCgw6PnF0MUS1q/9/X180rt4v 0XAZQ0t/RTy4JwJndXkxqW9MgYIUQ4sBsVld9lDD4/byLoFeRi8rg3hS0MSdGGLOldHO 43RL2zdy1mYlUywyQ3aNh2ieXP8yizzQGtF6EL7dYJoIkLsMVYIS+CUa/L1lgB4nUsdk l8GA== X-Gm-Message-State: AHQUAub4iBlgJ2hXNdqlRBybIukLvRuDSs3yi/Fa/n+l4btYTU4a5sQr 8TBnIxH/HMHdCxbOuqT2B4+W5cRG X-Google-Smtp-Source: AHgI3IZUrPSnHEJ+S8iFzqMHJWAn0Lb0oh9OdLnwF+wAxmq50ce238DA44Vwj3G9YNmJCMaHfRM0aw== X-Received: by 2002:a05:6830:1689:: with SMTP id k9mr6317726otr.129.1549123413450; Sat, 02 Feb 2019 08:03:33 -0800 (PST) Received: from mars (72-47-130-203.brhmcmtc01.res.dyn.suddenlink.net. [72.47.130.203]) by smtp.gmail.com with ESMTPSA id i5sm4952963oia.46.2019.02.02.08.03.32 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sat, 02 Feb 2019 08:03:32 -0800 (PST) References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: Eli Zaretskii Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions In-reply-to: <83zhrfyi1a.fsf@gnu.org> Date: Sat, 02 Feb 2019 10:03:31 -0600 Message-ID: <87y36y9nzg.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain On Fri 01 Feb 2019 at 03:28, Eli Zaretskii wrote: >> From: Alex Branham >> Cc: Marcin Borkowski , 21074@debbugs.gnu.org >> Date: Tue, 22 Jan 2019 15:03:41 -0600 >> >> >> +@defun tabulated-list-get-id &optional pos >> > >> > In the code, this is a defsubst, not a defun. >> >> How do we document these in the elisp manual? I'm struggling to find an >> example. Is it just: >> >> @findex{tabulated-list-get-id} >> tabulated-list-get-id &optional pod >> >> This function returns... >> >> ? > > I think just say in the description something like "This > @code{defsubst} returns...". >> This will be an ID object from @var{tabulated-list-entries} or >> calculated from that function if @var{tabulated-list-entries} is a >> function. > > This is the ID object from @code{tabulated-list-entries} (if that is > a list) or from the list returned by @code{tabulated-list-entries} > (if it is a function). > > Note: @code, not @var, because tabulated-list-entries is a literal > symbol, not an argument of a function. Thanks. I think the attached patch incorporates all your comments, let me know if I missed something. Alex --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Add-documentation-for-tabulated-list-functions-in-th.patch >From dcec7e84ccf9a612cfed6a9f607dc021eb964e1a Mon Sep 17 00:00:00 2001 From: Alex Branham Date: Sat, 2 Feb 2019 09:59:21 -0600 Subject: [PATCH] Add documentation for tabulated-list functions in the elisp manual * doc/lispref/modes.texi: Add documentation for 'tabulated-list-delete-entry', 'tabulated-list-get-id', 'tabulated-list-get-entry', 'tabulated-list-header-overlay-p', 'tabulated-list-put-tag', and 'tabulated-list-set-col'. --- doc/lispref/modes.texi | 53 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 143cc7c582..4635a5c6e4 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1121,6 +1121,59 @@ that tags placed via @code{tabulated-list-put-tag} will not be removed from entries that haven't changed (normally all tags are removed). @end defun +@defun tabulated-list-delete-entry +This function deletes the entry at point. + +It returns a list @code{(id cols)} where @var{id} is the ID of the +delete entry and @var{cols} is a vector of its column descriptors. +It moves point to the beginning of the deleted entry. It returns +@code{nil} if there is no entry at point. + +Note that this function only changes the buffer contents; it does not +alter @code{tabulated-list-entries}. +@end defun + +@defun tabulated-list-get-id &optional pos +This @code{defsubst} returns the ID object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). If +omitted or @code{nil}, @var{pos} defaults to point. +@end defun + +@defun tabulated-list-get-entry &optional pos +This @code{defsubst} returns the entry object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). This +will be a vector for the ID at @var{pos}. If there is no entry at +@var{pos}, then the function returns @code{nil}. +@end defun + +@defun tabulated-list-header-overlay-p &optional POS +This @code{defsubst} returns non-nil if there is a fake header at +@var{pos}. If omitted or @code{nil}, @var{pos} defaults to +@code{point-min}. +@end defun + +@defun tabulated-list-put-tag tag &optional advance +This function puts @var{tag} in the padding area of the current line. +@var{tag} should be a string, with a length less than or equal to +@code{tabulated-list-padding}. If @var{advance} is non-nil, this +function advances point by one line. +@end defun + +@defun tabulated-list-set-col col desc &optional change-entry-data +This function changes the tabulated list entry at point, setting +@var{col} to @var{desc}. @var{col} is the column number to change, or +the name of the column to change. @var{desc} is the new column +descriptor, which is inserted via @code{tabulated-list-print-col}. + +If @var{change-entry-data} is non-nil, this function modifies the +underlying entry data by setting the appropriate slot of the vector +originally used to print this entry. If @code{tabulated-list-entries} +has a list value, this is the vector stored within it. +@end defun + + @node Generic Modes @subsection Generic Modes @cindex generic mode -- 2.19.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Sat Feb 02 11:33:55 2019 Received: (at 21074) by debbugs.gnu.org; 2 Feb 2019 16:33:55 +0000 Received: from localhost ([127.0.0.1]:56543 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpyEt-0007L1-73 for submit@debbugs.gnu.org; Sat, 02 Feb 2019 11:33:55 -0500 Received: from eggs.gnu.org ([209.51.188.92]:49685) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpyEr-0007Ko-4i for 21074@debbugs.gnu.org; Sat, 02 Feb 2019 11:33:53 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:41396) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gpyEb-0004Cc-Tg; Sat, 02 Feb 2019 11:33:41 -0500 Received: from [176.228.60.248] (port=3289 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gpyEU-0005t4-IO; Sat, 02 Feb 2019 11:33:36 -0500 Date: Sat, 02 Feb 2019 18:33:01 +0200 Message-Id: <83h8dmw3pe.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham In-reply-to: <87y36y9nzg.fsf@gmail.com> (message from Alex Branham on Sat, 02 Feb 2019 10:03:31 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> <87y36y9nzg.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Cc: mbork@mbork.pl, 21074@debbugs.gnu.org > Date: Sat, 02 Feb 2019 10:03:31 -0600 > > Thanks. I think the attached patch incorporates all your comments, let > me know if I missed something. Looks good. A couple of minor gotchas, though. > * doc/lispref/modes.texi: Add documentation for > 'tabulated-list-delete-entry', 'tabulated-list-get-id', > 'tabulated-list-get-entry', 'tabulated-list-header-overlay-p', > 'tabulated-list-put-tag', and 'tabulated-list-set-col'. This should mention the bug number. > +@defun tabulated-list-delete-entry > +This function deletes the entry at point. > + > +It returns a list @code{(id cols)} where @var{id} is the ID of the ^ A comma is missing there. > +delete entry and @var{cols} is a vector of its column descriptors. ^ And here. Also, the "id" and "cols" inside the list should also have the @var markup. > +It moves point to the beginning of the deleted entry. The last sentence is confusing: if the entry is deleted, how can we move to its beginning? > +@defun tabulated-list-header-overlay-p &optional POS > +This @code{defsubst} returns non-nil if there is a fake header at > +@var{pos}. We should explain, in a single sentence if possible, what is a "fake header". It is never explained in this section. > +@defun tabulated-list-put-tag tag &optional advance > +This function puts @var{tag} in the padding area of the current line. And this should explain what is the padding area, for the same reason. > +@var{tag} should be a string, with a length less than or equal to > +@code{tabulated-list-padding}. Every variable mentioned in the manual should be indexed. So please add @vindex tabulated-list-padding before the @defun. > +If @var{change-entry-data} is non-nil, this function modifies the > +underlying entry data by setting the appropriate slot of the vector > +originally used to print this entry. If @code{tabulated-list-entries} > +has a list value, this is the vector stored within it. This paragraph is confusing, I cannot understand what that argument does just by reading the above text. (The doc string says the same, so it's of no help.) The confusing parts are "appropriate slot" and "originally used to print". The code simply modifies a component of the vector returned by tabulated-list-get-entry, so I wonder why the description needs to be that complicated. Thanks again for working on this. From debbugs-submit-bounces@debbugs.gnu.org Sat Feb 02 12:29:07 2019 Received: (at 21074) by debbugs.gnu.org; 2 Feb 2019 17:29:07 +0000 Received: from localhost ([127.0.0.1]:56561 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpz6I-0000FB-Jr for submit@debbugs.gnu.org; Sat, 02 Feb 2019 12:29:07 -0500 Received: from mail-oi1-f170.google.com ([209.85.167.170]:37252) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpz6G-0000Ei-TN for 21074@debbugs.gnu.org; Sat, 02 Feb 2019 12:29:05 -0500 Received: by mail-oi1-f170.google.com with SMTP id y23so8443958oia.4 for <21074@debbugs.gnu.org>; Sat, 02 Feb 2019 09:29:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=pIio96jpCKTZ7MRkY2VvBLFw9BetiiStjfwxbdmkuog=; b=eVpAetappQsW6kVYJNQK7ito2i5IG5/BwuqOJQTIrFVdDtgdfCQZeH/897KPvesAaV ZFBsRR9q5tXqeqbphH4OOsjr5fgST+jqPmR3u92G74AJQc3SyHLvNCDnHURnV4GYq3ut 3uF1/AQcB1hFDnnCSc2bb1DNfGS1r3O16Z9wlsxYUhwyvBi8fBXf/XT74PYV5PvAWt12 HSpAih3zqujJd/NWUwbCjSgu2Del1vL6W1nQKLvW6CVIcAaOYFGWrgouDTqlJKD43ivR 5M3cttGtB9yp/Ftw6LTkKUYVKXG8K8nQeUB4WRAbwj0naA6kn7gd05IzuGIZ3LzCl18E urCw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=pIio96jpCKTZ7MRkY2VvBLFw9BetiiStjfwxbdmkuog=; b=kCtaJNLXlrgAXVMbKayf/G7nn8Lq2gIy+2HI5Rx9ru/SXvWCAQ1/R8Qt9dQM/AEn/4 g5hMeBo5tiHklZ8jhSIUTrG8oIY+gEJNQnSBC7iMz3dU7RkZcESEEh2OqjYh4LuYoOLO s1M1VV0w+TKuFh2RDmMkzUhVTVPvietDzxf10PpoUsaUdHF8bRmZL8ADmCW7JwkzE96b cczVwCrGIhJx1D2o5QeZTwUJI/GlEQtpBLp233TLHEB1Fl7tpmgOlAlc8qy7HiN/P98z vy8q8D1Yz0ucSNSUUFI6mTkwahv/tH5Y42wLacImZ5+GH8QakVO6CG8pS27KDxvfwe9K F+Ow== X-Gm-Message-State: AHQUAuYZQMoEx3yvltmtBL65L4yb/sM4is1lXFeq56mRsVNlrculCl2a EXpvgIapLjpTGEG6jR9gp/5ZEr29 X-Google-Smtp-Source: AHgI3IYZSGR/0psP19zCAHgkMjrSEyP7GbwwwoExwxEMq6fVae2aLFN0ccQaDTtQy2IvVmrfuddFNg== X-Received: by 2002:aca:4e0a:: with SMTP id c10mr19020687oib.36.1549128538836; Sat, 02 Feb 2019 09:28:58 -0800 (PST) Received: from mars (72-47-130-203.brhmcmtc01.res.dyn.suddenlink.net. [72.47.130.203]) by smtp.gmail.com with ESMTPSA id m207sm5003630oig.2.2019.02.02.09.28.57 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sat, 02 Feb 2019 09:28:57 -0800 (PST) References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> <87y36y9nzg.fsf@gmail.com> <83h8dmw3pe.fsf@gnu.org> User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: Eli Zaretskii Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions In-reply-to: <83h8dmw3pe.fsf@gnu.org> Date: Sat, 02 Feb 2019 11:28:56 -0600 Message-ID: <87va229k13.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain On Sat 02 Feb 2019 at 10:33, Eli Zaretskii wrote: > This should mention the bug number. Thanks, done >> +@defun tabulated-list-delete-entry >> +This function deletes the entry at point. >> + >> +It returns a list @code{(id cols)} where @var{id} is the ID of the > ^ > A comma is missing there. Thanks, added. >> +delete entry and @var{cols} is a vector of its column descriptors. > ^ > And here. I don't think a comma is needed here. It's a list of two entries, not three, so no comma, right? > Also, the "id" and "cols" inside the list should also have the @var > markup. Thanks, added like @code{(@var{id} @var{cols})} >> +It moves point to the beginning of the deleted entry. > > The last sentence is confusing: if the entry is deleted, how can we > move to its beginning? Changed to "It moves point to the beginning of the current line." >> +@defun tabulated-list-header-overlay-p &optional POS >> +This @code{defsubst} returns non-nil if there is a fake header at >> +@var{pos}. > > We should explain, in a single sentence if possible, what is a "fake > header". It is never explained in this section. Added as "A fake header is used if @code{tabulated-list-use-header-line} is @code{nil} to put the column names at the beginning of the buffer." >> +@defun tabulated-list-put-tag tag &optional advance >> +This function puts @var{tag} in the padding area of the current line. > > And this should explain what is the padding area, for the same reason. Added as "The padding area can be empty space at the beginning of the line, the width of which is governed by @code{tabulated-list-padding}." >> +@var{tag} should be a string, with a length less than or equal to >> +@code{tabulated-list-padding}. > > Every variable mentioned in the manual should be indexed. So please > add > > @vindex tabulated-list-padding > > before the @defun. Done (also for tabulated-list-use-header-line) >> +If @var{change-entry-data} is non-nil, this function modifies the >> +underlying entry data by setting the appropriate slot of the vector >> +originally used to print this entry. If @code{tabulated-list-entries} >> +has a list value, this is the vector stored within it. > > This paragraph is confusing, I cannot understand what that argument > does just by reading the above text. (The doc string says the same, > so it's of no help.) The confusing parts are "appropriate slot" and > "originally used to print". The code simply modifies a component of > the vector returned by tabulated-list-get-entry, so I wonder why the > description needs to be that complicated. Changed to this, which is hopefully clearer: If @var{change-entry-data} is non-nil, this function modifies the underlying data (usually the column descriptor in the list @code{tabulated-list-entries}) by setting the column descriptor of the vector to @code{desc}. Thanks, Alex --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Add-documentation-for-tabulated-list-functions-in-th.patch >From 5d0a50705a19ad464d141ab3b4880dddf5cf37ea Mon Sep 17 00:00:00 2001 From: Alex Branham Date: Sat, 2 Feb 2019 09:59:21 -0600 Subject: [PATCH] Add documentation for tabulated-list functions in the elisp manual * doc/lispref/modes.texi: Add documentation for 'tabulated-list-delete-entry', 'tabulated-list-get-id', 'tabulated-list-get-entry', 'tabulated-list-header-overlay-p', 'tabulated-list-put-tag', and 'tabulated-list-set-col'. Bug#21074 --- doc/lispref/modes.texi | 59 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 143cc7c582..aeac421495 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1121,6 +1121,65 @@ that tags placed via @code{tabulated-list-put-tag} will not be removed from entries that haven't changed (normally all tags are removed). @end defun +@defun tabulated-list-delete-entry +This function deletes the entry at point. + +It returns a list @code{(@var{id} @var{cols})}, where @var{id} is the +ID of the delete entry and @var{cols} is a vector of its column +descriptors. It moves point to the beginning of the current line. +It returns @code{nil} if there is no entry at point. + +Note that this function only changes the buffer contents; it does not +alter @code{tabulated-list-entries}. +@end defun + +@defun tabulated-list-get-id &optional pos +This @code{defsubst} returns the ID object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). If +omitted or @code{nil}, @var{pos} defaults to point. +@end defun + +@defun tabulated-list-get-entry &optional pos +This @code{defsubst} returns the entry object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). This +will be a vector for the ID at @var{pos}. If there is no entry at +@var{pos}, then the function returns @code{nil}. +@end defun + +@vindex tabulated-list-use-header-line +@defun tabulated-list-header-overlay-p &optional POS +This @code{defsubst} returns non-nil if there is a fake header at +@var{pos}. A fake header is used if +@code{tabulated-list-use-header-line} is @code{nil} to put the column +names at the beginning of the buffer. If omitted or @code{nil}, +@var{pos} defaults to @code{point-min}. +@end defun + +@vindex tabulated-list-padding +@defun tabulated-list-put-tag tag &optional advance +This function puts @var{tag} in the padding area of the current line. +The padding area can be empty space at the beginning of the line, the +width of which is governed by @code{tabulated-list-padding}. +@var{tag} should be a string, with a length less than or equal to +@code{tabulated-list-padding}. If @var{advance} is non-nil, this +function advances point by one line. +@end defun + +@defun tabulated-list-set-col col desc &optional change-entry-data +This function changes the tabulated list entry at point, setting +@var{col} to @var{desc}. @var{col} is the column number to change, or +the name of the column to change. @var{desc} is the new column +descriptor, which is inserted via @code{tabulated-list-print-col}. + +If @var{change-entry-data} is non-nil, this function modifies the +underlying data (usually the column descriptor in the list +@code{tabulated-list-entries}) by setting the column descriptor of the +vector to @code{desc}. +@end defun + + @node Generic Modes @subsection Generic Modes @cindex generic mode -- 2.19.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Sat Feb 02 13:06:46 2019 Received: (at 21074) by debbugs.gnu.org; 2 Feb 2019 18:06:46 +0000 Received: from localhost ([127.0.0.1]:56576 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpzgj-0001AR-Re for submit@debbugs.gnu.org; Sat, 02 Feb 2019 13:06:46 -0500 Received: from eggs.gnu.org ([209.51.188.92]:51124) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gpzgi-0001AE-Am for 21074@debbugs.gnu.org; Sat, 02 Feb 2019 13:06:45 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:46078) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gpzgZ-0003VQ-A5; Sat, 02 Feb 2019 13:06:36 -0500 Received: from [176.228.60.248] (port=1173 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gpzgY-0005CJ-PR; Sat, 02 Feb 2019 13:06:35 -0500 Date: Sat, 02 Feb 2019 20:06:13 +0200 Message-Id: <83ef8qvze2.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham In-reply-to: <87va229k13.fsf@gmail.com> (message from Alex Branham on Sat, 02 Feb 2019 11:28:56 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> <87y36y9nzg.fsf@gmail.com> <83h8dmw3pe.fsf@gnu.org> <87va229k13.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Cc: mbork@mbork.pl, 21074@debbugs.gnu.org > Date: Sat, 02 Feb 2019 11:28:56 -0600 > > >> +delete entry and @var{cols} is a vector of its column descriptors. > > ^ > > And here. > > I don't think a comma is needed here. It's a list of two entries, not > three, so no comma, right? Hmm.. I guess I was confused by the "delete entry" -- you meant "deleted", right? Otherwise OK. Thanks. From debbugs-submit-bounces@debbugs.gnu.org Tue Feb 05 15:09:04 2019 Received: (at 21074) by debbugs.gnu.org; 5 Feb 2019 20:09:04 +0000 Received: from localhost ([127.0.0.1]:33782 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gr71i-0000om-B0 for submit@debbugs.gnu.org; Tue, 05 Feb 2019 15:09:04 -0500 Received: from mail-ot1-f66.google.com ([209.85.210.66]:38179) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gr71g-0000oH-FH for 21074@debbugs.gnu.org; Tue, 05 Feb 2019 15:09:01 -0500 Received: by mail-ot1-f66.google.com with SMTP id e12so7992418otl.5 for <21074@debbugs.gnu.org>; Tue, 05 Feb 2019 12:09:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=JntIwTApTZGywI6O6F8HWS/tEo13PB50O9s3fpWSSHM=; b=c9qEN6V3mgUPYvmGI6qxhUYRSeh5QnH6+lm67YOk9iK46H1ldolD7/lxoMQyV4T4sj a5mKqFIaeFv5hz271g0ZQt0E69qHN9GoimX0s39Rcgve4HbHP3DCNUWR5ZVf3eRVQdCP jYgDR7XqlnklFa/GUGi5+/hfr+62UV5pccaYwRFvca3ju/1be66wzYdIXJIoseaFRXKX cgv1JzfmeHOBdJMpLVDUcq3CiOWebtpAndLu6Y7mqqwxWy8kBVZYN8qBb8TewULPlBPz YFvjGRs9JxgeJPEbQwdovLPrv3dyrMte5qCVVSiQdLPq0GrFY+0jMR5Cqo21JqrFvws+ 8J2w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=JntIwTApTZGywI6O6F8HWS/tEo13PB50O9s3fpWSSHM=; b=DMGNhiZjAmDHUgK4p7JdvNvyDGew7Ch//lrB1wjvGObBH05phBusvCJRWnwByLkbtW 2Q8KxyGNjNgvtnwq08KyeSGGB9eFQqdLkW1f+ihZ0vhcFC1nv2Hmclr1kTcWt0tU+zI3 8QKdh1Av2zyd6JusKEo0YQFwqyDVNRVDsJasQ5K08CA/pleZDdeKjjiZbAe14Am7jKax KJsY/FHnc8tqZMgVj6GU4arP/jRRqk+ijMy0mqTZ00cO2/vXTAdzGj+ZMs9FEUOkr4Ed GTHM4qpCaBj7OB8QgGlu/XQvMQX5EkG924983tLaN2t2DbsrbghjiX2aMgpIg2+BUtgX q2aQ== X-Gm-Message-State: AHQUAubGRXwN4iIkVDUtgvepy6sUl6LpamTRFpgghuWWLX0ZLaRbyrOe xsBbuGpxoMDlwCM5SmKuVA7nwih7 X-Google-Smtp-Source: AHgI3IYs5gvM4gB0jSFSz4gp+zs3GpsR/4LAqE9uMj/4vm+JtycGOVCL/bdiMk5Z7sDY7fGIKU45ag== X-Received: by 2002:a9d:3d42:: with SMTP id a60mr3549363otc.285.1549397334084; Tue, 05 Feb 2019 12:08:54 -0800 (PST) Received: from mars (nat-128-62-27-80.public.utexas.edu. [128.62.27.80]) by smtp.gmail.com with ESMTPSA id u19sm9234294oia.31.2019.02.05.12.08.53 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 05 Feb 2019 12:08:53 -0800 (PST) References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> <87y36y9nzg.fsf@gmail.com> <83h8dmw3pe.fsf@gnu.org> <87va229k13.fsf@gmail.com> <83ef8qvze2.fsf@gnu.org> User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: Eli Zaretskii Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions In-reply-to: <83ef8qvze2.fsf@gnu.org> Date: Tue, 05 Feb 2019 14:08:50 -0600 Message-ID: <874l9i6lrh.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain On Sat 02 Feb 2019 at 12:06, Eli Zaretskii wrote: >> >> +delete entry and @var{cols} is a vector of its column descriptors. >> > ^ >> > And here. >> >> I don't think a comma is needed here. It's a list of two entries, not >> three, so no comma, right? > > Hmm.. I guess I was confused by the "delete entry" -- you meant > "deleted", right? Whoops, yes I meant "deleted." Fixed in the attached patch. > Otherwise OK. Great! Should I push this to master, then, or do you want to? Thanks, Alex >From 3460d745215bbbf24350786753602bf06c23e139 Mon Sep 17 00:00:00 2001 From: Alex Branham Date: Sat, 2 Feb 2019 09:59:21 -0600 Subject: [PATCH] Add documentation for tabulated-list functions in the elisp manual * doc/lispref/modes.texi: Add documentation for 'tabulated-list-delete-entry', 'tabulated-list-get-id', 'tabulated-list-get-entry', 'tabulated-list-header-overlay-p', 'tabulated-list-put-tag', and 'tabulated-list-set-col'. Bug#21074 --- doc/lispref/modes.texi | 59 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 143cc7c582..6349dec98b 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1121,6 +1121,65 @@ that tags placed via @code{tabulated-list-put-tag} will not be removed from entries that haven't changed (normally all tags are removed). @end defun +@defun tabulated-list-delete-entry +This function deletes the entry at point. + +It returns a list @code{(@var{id} @var{cols})}, where @var{id} is the +ID of the deleted entry and @var{cols} is a vector of its column +descriptors. It moves point to the beginning of the current line. It +returns @code{nil} if there is no entry at point. + +Note that this function only changes the buffer contents; it does not +alter @code{tabulated-list-entries}. +@end defun + +@defun tabulated-list-get-id &optional pos +This @code{defsubst} returns the ID object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). If +omitted or @code{nil}, @var{pos} defaults to point. +@end defun + +@defun tabulated-list-get-entry &optional pos +This @code{defsubst} returns the entry object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). This +will be a vector for the ID at @var{pos}. If there is no entry at +@var{pos}, then the function returns @code{nil}. +@end defun + +@vindex tabulated-list-use-header-line +@defun tabulated-list-header-overlay-p &optional POS +This @code{defsubst} returns non-nil if there is a fake header at +@var{pos}. A fake header is used if +@code{tabulated-list-use-header-line} is @code{nil} to put the column +names at the beginning of the buffer. If omitted or @code{nil}, +@var{pos} defaults to @code{point-min}. +@end defun + +@vindex tabulated-list-padding +@defun tabulated-list-put-tag tag &optional advance +This function puts @var{tag} in the padding area of the current line. +The padding area can be empty space at the beginning of the line, the +width of which is governed by @code{tabulated-list-padding}. +@var{tag} should be a string, with a length less than or equal to +@code{tabulated-list-padding}. If @var{advance} is non-nil, this +function advances point by one line. +@end defun + +@defun tabulated-list-set-col col desc &optional change-entry-data +This function changes the tabulated list entry at point, setting +@var{col} to @var{desc}. @var{col} is the column number to change, or +the name of the column to change. @var{desc} is the new column +descriptor, which is inserted via @code{tabulated-list-print-col}. + +If @var{change-entry-data} is non-nil, this function modifies the +underlying data (usually the column descriptor in the list +@code{tabulated-list-entries}) by setting the column descriptor of the +vector to @code{desc}. +@end defun + + @node Generic Modes @subsection Generic Modes @cindex generic mode -- 2.19.2 --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Add-documentation-for-tabulated-list-functions-in-th.patch >From 3460d745215bbbf24350786753602bf06c23e139 Mon Sep 17 00:00:00 2001 From: Alex Branham Date: Sat, 2 Feb 2019 09:59:21 -0600 Subject: [PATCH] Add documentation for tabulated-list functions in the elisp manual * doc/lispref/modes.texi: Add documentation for 'tabulated-list-delete-entry', 'tabulated-list-get-id', 'tabulated-list-get-entry', 'tabulated-list-header-overlay-p', 'tabulated-list-put-tag', and 'tabulated-list-set-col'. Bug#21074 --- doc/lispref/modes.texi | 59 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 143cc7c582..6349dec98b 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1121,6 +1121,65 @@ that tags placed via @code{tabulated-list-put-tag} will not be removed from entries that haven't changed (normally all tags are removed). @end defun +@defun tabulated-list-delete-entry +This function deletes the entry at point. + +It returns a list @code{(@var{id} @var{cols})}, where @var{id} is the +ID of the deleted entry and @var{cols} is a vector of its column +descriptors. It moves point to the beginning of the current line. It +returns @code{nil} if there is no entry at point. + +Note that this function only changes the buffer contents; it does not +alter @code{tabulated-list-entries}. +@end defun + +@defun tabulated-list-get-id &optional pos +This @code{defsubst} returns the ID object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). If +omitted or @code{nil}, @var{pos} defaults to point. +@end defun + +@defun tabulated-list-get-entry &optional pos +This @code{defsubst} returns the entry object from +@code{tabulated-list-entries} (if that is a list) or from the list +returned by @code{tabulated-list-entries} (if it is a function). This +will be a vector for the ID at @var{pos}. If there is no entry at +@var{pos}, then the function returns @code{nil}. +@end defun + +@vindex tabulated-list-use-header-line +@defun tabulated-list-header-overlay-p &optional POS +This @code{defsubst} returns non-nil if there is a fake header at +@var{pos}. A fake header is used if +@code{tabulated-list-use-header-line} is @code{nil} to put the column +names at the beginning of the buffer. If omitted or @code{nil}, +@var{pos} defaults to @code{point-min}. +@end defun + +@vindex tabulated-list-padding +@defun tabulated-list-put-tag tag &optional advance +This function puts @var{tag} in the padding area of the current line. +The padding area can be empty space at the beginning of the line, the +width of which is governed by @code{tabulated-list-padding}. +@var{tag} should be a string, with a length less than or equal to +@code{tabulated-list-padding}. If @var{advance} is non-nil, this +function advances point by one line. +@end defun + +@defun tabulated-list-set-col col desc &optional change-entry-data +This function changes the tabulated list entry at point, setting +@var{col} to @var{desc}. @var{col} is the column number to change, or +the name of the column to change. @var{desc} is the new column +descriptor, which is inserted via @code{tabulated-list-print-col}. + +If @var{change-entry-data} is non-nil, this function modifies the +underlying data (usually the column descriptor in the list +@code{tabulated-list-entries}) by setting the column descriptor of the +vector to @code{desc}. +@end defun + + @node Generic Modes @subsection Generic Modes @cindex generic mode -- 2.19.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Tue Feb 05 15:27:05 2019 Received: (at 21074) by debbugs.gnu.org; 5 Feb 2019 20:27:05 +0000 Received: from localhost ([127.0.0.1]:33793 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gr7JA-0001Ez-Vl for submit@debbugs.gnu.org; Tue, 05 Feb 2019 15:27:05 -0500 Received: from eggs.gnu.org ([209.51.188.92]:37263) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gr7J7-0001EU-KG for 21074@debbugs.gnu.org; Tue, 05 Feb 2019 15:27:02 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:50397) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gr7J1-0002o5-Kv; Tue, 05 Feb 2019 15:26:55 -0500 Received: from [176.228.60.248] (port=1899 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gr7J1-0008Ab-8R; Tue, 05 Feb 2019 15:26:55 -0500 Date: Tue, 05 Feb 2019 22:26:42 +0200 Message-Id: <837eeet20t.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham In-reply-to: <874l9i6lrh.fsf@gmail.com> (message from Alex Branham on Tue, 05 Feb 2019 14:08:50 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> <87y36y9nzg.fsf@gmail.com> <83h8dmw3pe.fsf@gnu.org> <87va229k13.fsf@gmail.com> <83ef8qvze2.fsf@gnu.org> <874l9i6lrh.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Cc: mbork@mbork.pl, 21074@debbugs.gnu.org > Date: Tue, 05 Feb 2019 14:08:50 -0600 > > > Otherwise OK. > > Great! Should I push this to master, then, or do you want to? Go ahead and push, but to emacs-26 (the same functions exist there as well, right?). And thanks for working on this. From debbugs-submit-bounces@debbugs.gnu.org Tue Feb 05 15:50:43 2019 Received: (at 21074-done) by debbugs.gnu.org; 5 Feb 2019 20:50:43 +0000 Received: from localhost ([127.0.0.1]:33806 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gr7g3-0001nm-Jy for submit@debbugs.gnu.org; Tue, 05 Feb 2019 15:50:43 -0500 Received: from mail-ot1-f46.google.com ([209.85.210.46]:33918) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gr7g1-0001nZ-P4 for 21074-done@debbugs.gnu.org; Tue, 05 Feb 2019 15:50:42 -0500 Received: by mail-ot1-f46.google.com with SMTP id t5so8269869otk.1 for <21074-done@debbugs.gnu.org>; Tue, 05 Feb 2019 12:50:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=6R7CuCrZTeGKwjYfWeXz0Bz9cegysri+SmyHVOfXrU0=; b=o1WnRkgYdpr+ehlTqTj4QY44fMW7sb6sGFdoxPjCxXmy7HFXEHVjCPS7753BjlBwSP FJ8HE5Xnb8lRHlAH7Qz03LaNNJlQrHZnV/3haGBqS5cJux4XYsNv/k8SWR1u/xZ73cKh cbIIba7FJ959hBsDdXrbmOrdodwNwUaK2q6FTXNwZnGa3PN0mCk/pGMU90icXfiZ6Gzi CsljsA0gP31yQn29OYTcd218EMJFJDT77u1upknngSLbj1pbMiBnRjVq8ZhVIDo2y8wT cif6PUng3If0KSvpN98bcFrEghA0g1CbioHRCW25aCxMZ+9sKLOIx6vRcopGCFnBXTCz 6AEQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=6R7CuCrZTeGKwjYfWeXz0Bz9cegysri+SmyHVOfXrU0=; b=CqYlDve0fLSw9FIEot41oWNxdFEgHz0IhsF7tB4FFt8KwQiDz3jbAkEFxBlLYjB+Lc 46QN88/Et2PxVCKBtSUTBDEA0TIXRnotA1DVmpBfwm5sTKumM9TAZXtFrU2D+eqYLBXX s3B7UY2EtTUbHMsHMtrmzEL3uX8oTMsMACfdiAoziZ9wsGB7qFqf4gNYguLXix1P/SWz a9MXNGIwtgG7UTTWnBlQvnRvpKvAmnTlTOxI3o1L4semYvgToBWif4lC5/IlPSzfsLjF put7ML592Gg9ebvAMw4jGNoIBXROfLvVn7heqrAGI5AjYZ4Q+UNulFi6f4HGc7s4CZ+e u4RQ== X-Gm-Message-State: AHQUAuaHO3lGZfjgyt7q187yr0UpvWv8EdCmUgBjvvYdU1A8wumDkMCQ d4PVgkFYH5LC/d1iDXoH0KKtUt08 X-Google-Smtp-Source: AHgI3IZFdY4ghAh8bNfpTCav6KssSwna4dV8ichg4oxKG1cW4lot19OTWmeWDalcWj6iwPqOL9Wvjg== X-Received: by 2002:a9d:2007:: with SMTP id n7mr3459549ota.157.1549399835672; Tue, 05 Feb 2019 12:50:35 -0800 (PST) Received: from mars (nat-128-62-27-80.public.utexas.edu. [128.62.27.80]) by smtp.gmail.com with ESMTPSA id r21sm8564323otk.18.2019.02.05.12.50.34 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 05 Feb 2019 12:50:34 -0800 (PST) References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> <87y36y9nzg.fsf@gmail.com> <83h8dmw3pe.fsf@gnu.org> <87va229k13.fsf@gmail.com> <83ef8qvze2.fsf@gnu.org> <874l9i6lrh.fsf@gmail.com> <837eeet20t.fsf@gnu.org> User-agent: mu4e 1.1.0; emacs 27.0.50 From: Alex Branham To: Eli Zaretskii Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions In-reply-to: <837eeet20t.fsf@gnu.org> Date: Tue, 05 Feb 2019 14:50:33 -0600 Message-ID: <8736p26jty.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21074-done Cc: mbork@mbork.pl, 21074-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain On Tue 05 Feb 2019 at 14:26, Eli Zaretskii wrote: > Go ahead and push, but to emacs-26 (the same functions exist there as > well, right?). And thanks for working on this. OK, I think I did so. This is my first direct push to Emacs, so let me know if it doesn't show up or if I did something wrong. Thanks again, Alex --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEEeEJ4XAMgliXNXicpHkInolPpmscFAlxZ9xkACgkQHkInolPp mseFcAf+JCG3GagE7irbmTIzmjg7tL0hRdNalccYjgVybgTfo9UH8g/7gdzqukcN ThuZsaTgBR8aul4igrAwIVic8wNBQ0Yskz3qPFcEOqscVpW3iT3X/4mNuCmvwqtk +y7wPgb51XqNxI4m3PJWcj1GS/bipwBhQzkUXffr0qTvsxHKdtTAPhnDn2MiJvXC pab8F/Jf7LwBA73cEVHNHRDDwKtziqP32zg8IP+9ZHdvRkprQeWe5esY78v+grDL fuHS2kRAc8HslKffEd1cPIHZCRdFeOutVPRJKux5BdvyRg0H7Az8viZUIPZYFCdR 33iZj7dsupVbxFHAlwEyme65gZJNAA== =Mym7 -----END PGP SIGNATURE----- --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Tue Feb 05 22:32:44 2019 Received: (at 21074) by debbugs.gnu.org; 6 Feb 2019 03:32:44 +0000 Received: from localhost ([127.0.0.1]:33912 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1grDx6-0007JG-J9 for submit@debbugs.gnu.org; Tue, 05 Feb 2019 22:32:44 -0500 Received: from eggs.gnu.org ([209.51.188.92]:46398) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1grDx4-0007J1-QY for 21074@debbugs.gnu.org; Tue, 05 Feb 2019 22:32:43 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:58656) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1grDwy-0003AM-KX; Tue, 05 Feb 2019 22:32:36 -0500 Received: from [176.228.60.248] (port=4151 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1grDwy-0002Wl-8h; Tue, 05 Feb 2019 22:32:36 -0500 Date: Wed, 06 Feb 2019 05:32:27 +0200 Message-Id: <835ztxtwvo.fsf@gnu.org> From: Eli Zaretskii To: Alex Branham In-reply-to: <8736p26jty.fsf@gmail.com> (message from Alex Branham on Tue, 05 Feb 2019 14:50:33 -0600) Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions References: <87a8uwmq0d.fsf@mbork.pl> <871s5diy1q.fsf@gmail.com> <83won5d9ll.fsf@gnu.org> <87zhs1hfo7.fsf@gmail.com> <83k1j1awba.fsf@gnu.org> <87k1iwl80i.fsf@gmail.com> <83zhrfyi1a.fsf@gnu.org> <87y36y9nzg.fsf@gmail.com> <83h8dmw3pe.fsf@gnu.org> <87va229k13.fsf@gmail.com> <83ef8qvze2.fsf@gnu.org> <874l9i6lrh.fsf@gmail.com> <837eeet20t.fsf@gnu.org> <8736p26jty.fsf@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 21074 Cc: 21074@debbugs.gnu.org, mbork@mbork.pl X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) > From: Alex Branham > Cc: mbork@mbork.pl, 21074-done@debbugs.gnu.org > Date: Tue, 05 Feb 2019 14:50:33 -0600 > > > Go ahead and push, but to emacs-26 (the same functions exist there as > > well, right?). And thanks for working on this. > > OK, I think I did so. This is my first direct push to Emacs, so let me > know if it doesn't show up or if I did something wrong. Looks OK, but the log message should state the names of the functions in which you made the changes. For manuals, "functions" are nodes. The command "C-x 4 a" should help you create such entries. From unknown Sun Jun 22 17:15:35 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Wed, 06 Mar 2019 12:24:05 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator