bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#21074: [PATCH] Add docs for two tabulated-list functions


From: Alex Branham
Subject: bug#21074: [PATCH] Add docs for two tabulated-list functions
Date: Tue, 15 Jan 2019 12:19:13 -0600
User-agent: mu4e 1.1.0; emacs 27.0.50

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 <address@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

address@hidden 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}.
address@hidden defun
+
address@hidden 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
address@hidden from @var{tabulated-list-entries}. If there is no entry at
address@hidden, then the function returns @code{nil}.
address@hidden defun
+
+
 @node Generic Modes
 @subsection Generic Modes
 @cindex generic mode
--
2.19.2

>From 00a4e4ef99099d5c7f597a07c374a7e679cbe851 Mon Sep 17 00:00:00 2001
From: Alex Branham <address@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
 
address@hidden 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}.
address@hidden defun
+
address@hidden 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
address@hidden from @var{tabulated-list-entries}. If there is no entry at
address@hidden, then the function returns @code{nil}.
address@hidden defun
+
+
 @node Generic Modes
 @subsection Generic Modes
 @cindex generic mode
-- 
2.19.2


reply via email to

[Prev in Thread] Current Thread [Next in Thread]