GNU bug report logs - #21074
25.0.50; Incomplete docs for tabulated-list-mode

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Severity: minor; Reported by: Marcin Borkowski <mbork@HIDDEN>; dated Thu, 16 Jul 2015 09:06:01 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.

Message received at 21074 <at> debbugs.gnu.org:


Received: (at 21074) by debbugs.gnu.org; 22 Jan 2019 21:03:53 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Jan 22 16:03:53 2019
Received: from localhost ([127.0.0.1]:41618 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1gm3D7-0007Tw-C7
	for submit <at> 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 <alex.branham@HIDDEN>) id 1gm3D4-0007Tj-A5
 for 21074 <at> 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 <at> 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@HIDDEN> <871s5diy1q.fsf@HIDDEN>
 <83won5d9ll.fsf@HIDDEN> <87zhs1hfo7.fsf@HIDDEN> <83k1j1awba.fsf@HIDDEN>
User-agent: mu4e 1.1.0; emacs 27.0.50
From: Alex Branham <alex.branham@HIDDEN>
To: Eli Zaretskii <eliz@HIDDEN>
Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions
In-reply-to: <83k1j1awba.fsf@HIDDEN>
Date: Tue, 22 Jan 2019 15:03:41 -0600
Message-ID: <87k1iwl80i.fsf@HIDDEN>
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 <at> debbugs.gnu.org, Marcin Borkowski <mbork@HIDDEN>
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
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 <eliz@HIDDEN> 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-----
--=-=-=--




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.

Message received at 21074 <at> debbugs.gnu.org:


Received: (at 21074) by debbugs.gnu.org; 21 Jan 2019 16:33:13 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Jan 21 11:33:13 2019
Received: from localhost ([127.0.0.1]:40377 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1glcVc-0001qb-Ng
	for submit <at> 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 <eliz@HIDDEN>) id 1glcVZ-0001qM-SW
 for 21074 <at> 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 <eliz@HIDDEN>)
 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 <eliz@HIDDEN>)
 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@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
To: Alex Branham <alex.branham@HIDDEN>
In-reply-to: <875zuic7mh.fsf@HIDDEN> (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@HIDDEN> <871s5diy1q.fsf@HIDDEN>
 <83won5d9ll.fsf@HIDDEN> <87zhs1hfo7.fsf@HIDDEN> <83k1j1awba.fsf@HIDDEN>
 <875zuic7mh.fsf@HIDDEN>
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 <at> debbugs.gnu.org, mbork@HIDDEN
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

> From: Alex Branham <alex.branham@HIDDEN>
> Cc: Marcin Borkowski <mbork@HIDDEN>, 21074 <at> 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.




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.

Message received at 21074 <at> debbugs.gnu.org:


Received: (at 21074) by debbugs.gnu.org; 21 Jan 2019 16:12:33 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Jan 21 11:12:33 2019
Received: from localhost ([127.0.0.1]:40362 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1glcBd-0001KZ-7K
	for submit <at> 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 <alex.branham@HIDDEN>) id 1glcBa-0001KM-LQ
 for 21074 <at> 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 <at> 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@HIDDEN> <871s5diy1q.fsf@HIDDEN>
 <83won5d9ll.fsf@HIDDEN> <87zhs1hfo7.fsf@HIDDEN> <83k1j1awba.fsf@HIDDEN>
User-agent: mu4e 1.1.0; emacs 27.0.50
From: Alex Branham <alex.branham@HIDDEN>
To: Eli Zaretskii <eliz@HIDDEN>
Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions
In-reply-to: <83k1j1awba.fsf@HIDDEN>
Date: Mon, 21 Jan 2019 10:12:22 -0600
Message-ID: <875zuic7mh.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 21074
Cc: 21074 <at> debbugs.gnu.org, Marcin Borkowski <mbork@HIDDEN>
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)


On Sat 19 Jan 2019 at 02:25, Eli Zaretskii <eliz@HIDDEN> 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




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.

Message received at 21074 <at> debbugs.gnu.org:


Received: (at 21074) by debbugs.gnu.org; 19 Jan 2019 08:25:45 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Jan 19 03:25:44 2019
Received: from localhost ([127.0.0.1]:37280 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1gklwm-0002Ae-K7
	for submit <at> 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 <eliz@HIDDEN>) id 1gklwk-0002AQ-5j
 for 21074 <at> 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 <eliz@HIDDEN>)
 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 <eliz@HIDDEN>)
 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@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
To: Alex Branham <alex.branham@HIDDEN>, Marcin Borkowski <mbork@HIDDEN>
In-reply-to: <87zhs1hfo7.fsf@HIDDEN> (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@HIDDEN> <871s5diy1q.fsf@HIDDEN>
 <83won5d9ll.fsf@HIDDEN> <87zhs1hfo7.fsf@HIDDEN>
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 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

> From: Alex Branham <alex.branham@HIDDEN>
> Cc: 21074 <at> debbugs.gnu.org
> Date: Tue, 15 Jan 2019 13:41:28 -0600
> 
> On Tue 15 Jan 2019 at 13:06, Eli Zaretskii <eliz@HIDDEN> wrote:
> 
> >> From: Alex Branham <alex.branham@HIDDEN>
> >> 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.




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.

Message received at 21074 <at> debbugs.gnu.org:


Received: (at 21074) by debbugs.gnu.org; 15 Jan 2019 19:41:39 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Jan 15 14:41:39 2019
Received: from localhost ([127.0.0.1]:60391 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1gjUah-0003ld-2b
	for submit <at> 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 <alex.branham@HIDDEN>) id 1gjUae-0003lP-22
 for 21074 <at> 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 <at> 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@HIDDEN> <871s5diy1q.fsf@HIDDEN>
 <83won5d9ll.fsf@HIDDEN>
User-agent: mu4e 1.1.0; emacs 27.0.50
From: Alex Branham <alex.branham@HIDDEN>
To: Eli Zaretskii <eliz@HIDDEN>
Subject: Re: bug#21074: [PATCH] Add docs for two tabulated-list functions
In-reply-to: <83won5d9ll.fsf@HIDDEN>
Date: Tue, 15 Jan 2019 13:41:28 -0600
Message-ID: <87zhs1hfo7.fsf@HIDDEN>
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 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

--=-=-=
Content-Type: text/plain


On Tue 15 Jan 2019 at 13:06, Eli Zaretskii <eliz@HIDDEN> wrote:

>> From: Alex Branham <alex.branham@HIDDEN>
>> 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-----
--=-=-=--




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.

Message received at 21074 <at> debbugs.gnu.org:


Received: (at 21074) by debbugs.gnu.org; 15 Jan 2019 19:06:44 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Jan 15 14:06:44 2019
Received: from localhost ([127.0.0.1]:60375 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1gjU2u-0002to-MK
	for submit <at> 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 <eliz@HIDDEN>) id 1gjU2t-0002tc-B9
 for 21074 <at> 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 <eliz@HIDDEN>)
 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 <eliz@HIDDEN>)
 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@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
To: Alex Branham <alex.branham@HIDDEN>
In-reply-to: <871s5diy1q.fsf@HIDDEN> (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@HIDDEN> <871s5diy1q.fsf@HIDDEN>
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 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

> From: Alex Branham <alex.branham@HIDDEN>
> 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?




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.

Message received at 21074 <at> debbugs.gnu.org:


Received: (at 21074) by debbugs.gnu.org; 15 Jan 2019 18:19:25 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Jan 15 13:19:25 2019
Received: from localhost ([127.0.0.1]:60350 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1gjTJ6-0001kp-O4
	for submit <at> 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 <alex.branham@HIDDEN>) id 1gjTJ3-0001kY-Ec
 for 21074 <at> 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 <at> 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 <at> 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 <alex.branham@HIDDEN>
To: 21074 <at> 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@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
X-Spam-Score: -0.0 (/)
X-Debbugs-Envelope-To: 21074
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
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 <alex.branham@HIDDEN>
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 <alex.branham@HIDDEN>
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


--=-=-=--




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 16 Jul 2015 09:05:53 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Thu Jul 16 05:05:53 2015
Received: from localhost ([127.0.0.1]:50632 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.80)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1ZFf72-00035F-My
	for submit <at> 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 <mbork@HIDDEN>) id 1ZFf70-000350-6s
 for submit <at> 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 <mbork@HIDDEN>) id 1ZFf6t-0006o0-GX
 for submit <at> 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 <mbork@HIDDEN>) id 1ZFf6t-0006nv-DQ
 for submit <at> 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 <mbork@HIDDEN>) id 1ZFf6r-0007PA-Mv
 for bug-gnu-emacs@HIDDEN; Thu, 16 Jul 2015 05:05:43 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <mbork@HIDDEN>) id 1ZFf6n-0006mT-CI
 for bug-gnu-emacs@HIDDEN; 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 <mbork@HIDDEN>) id 1ZFf6n-0006lk-5T
 for bug-gnu-emacs@HIDDEN; 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 <bug-gnu-emacs@HIDDEN>; 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 <bug-gnu-emacs@HIDDEN>;
 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 <bug-gnu-emacs@HIDDEN>; Thu, 16 Jul 2015 11:05:31 +0200 (CEST)
From: Marcin Borkowski <mbork@HIDDEN>
To: bug-gnu-emacs@HIDDEN
Subject: 25.0.50; Incomplete docs for tabulated-list-mode
Date: Thu, 16 Jul 2015 11:05:22 +0200
Message-ID: <87a8uwmq0d.fsf@HIDDEN>
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 <at> debbugs.gnu.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
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




Acknowledgement sent to Marcin Borkowski <mbork@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#21074; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Tue, 22 Jan 2019 21:15:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.