From: Eli Zaretskii <eliz@gnu.org>
To: Alex Branham <alex.branham@gmail.com>
Cc: 21074@debbugs.gnu.org, mbork@mbork.pl
Subject: bug#21074: [PATCH] Add docs for two tabulated-list functions
Date: Fri, 01 Feb 2019 11:28:17 +0200 [thread overview]
Message-ID: <83zhrfyi1a.fsf@gnu.org> (raw)
In-Reply-To: <87k1iwl80i.fsf@gmail.com> (message from Alex Branham on Tue, 22 Jan 2019 15:03:41 -0600)
> From: Alex Branham <alex.branham@gmail.com>
> Cc: Marcin Borkowski <mbork@mbork.pl>, 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.
next prev parent reply other threads:[~2019-02-01 9:28 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-07-16 9:05 bug#21074: 25.0.50; Incomplete docs for tabulated-list-mode Marcin Borkowski
2019-01-15 18:19 ` bug#21074: [PATCH] Add docs for two tabulated-list functions Alex Branham
2019-01-15 19:06 ` Eli Zaretskii
2019-01-15 19:41 ` Alex Branham
2019-01-19 8:25 ` Eli Zaretskii
2019-01-21 16:12 ` Alex Branham
2019-01-21 16:32 ` Eli Zaretskii
2019-01-22 21:03 ` Alex Branham
2019-02-01 9:28 ` Eli Zaretskii [this message]
2019-02-02 16:03 ` Alex Branham
2019-02-02 16:33 ` Eli Zaretskii
2019-02-02 17:28 ` Alex Branham
2019-02-02 18:06 ` Eli Zaretskii
2019-02-05 20:08 ` Alex Branham
2019-02-05 20:26 ` Eli Zaretskii
2019-02-05 20:50 ` Alex Branham
2019-02-06 3:32 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83zhrfyi1a.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=21074@debbugs.gnu.org \
--cc=alex.branham@gmail.com \
--cc=mbork@mbork.pl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.