emacs-elpa-diffs
[Top][All Lists]
Advanced

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

[elpa] externals/ilist 8b26900739: Fix documentation error


From: ELPA Syncer
Subject: [elpa] externals/ilist 8b26900739: Fix documentation error
Date: Wed, 29 Dec 2021 19:57:32 -0500 (EST)

branch: externals/ilist
commit 8b26900739dd37ad1a094ef88207c2953de05c13
Author: JSDurand <mmemmew@gmail.com>
Commit: JSDurand <mmemmew@gmail.com>

    Fix documentation error
    
    Fix an error in the documentation about the convention of the sorter
    function argument for group labels.
---
 README.org    | 19 +++++++------------
 ilist.texinfo | 16 +++++-----------
 2 files changed, 12 insertions(+), 23 deletions(-)

diff --git a/README.org b/README.org
index 8c0ecfb30b..d8345a2b83 100644
--- a/README.org
+++ b/README.org
@@ -119,18 +119,13 @@ This macro is called as follows.
   instead of nil, then?  Well, people make mistakes all the time, at
   least I do.  So I think this mechanism can help people to remember
   give a default label for elements. 
-- SORTER: This can be a symbol, or an s-expression.
-
-  If it is a symbol, it will be used as the sorting function of the
-  group labels.  Note that one does not have to quote this symbol,
-  though you can still quote it.
-
-  If it is an s-expression., it will be used to define a function
-  =ilist-automatic-group-NAME-sorter=, which then becomes the sorting
-  function.  The variables =X= and =Y= are bound to the labels to sort
-  in this expression.  The sorter function should return a non-nil
-  value if and only if the group labelled =X= should be displayed
-  before the group labelled =Y=.
+- SORTER: This should be a function, or the symbol of a function.
+
+  This will be used as the sorting function of the group labels.  The
+  sorter function should accept two arguments, and should return a
+  non-nil value if and only if the group labelled by the first
+  argument should be displayed before the group labelled by the second
+  argument.
 
 * Mapping over lines
 
diff --git a/ilist.texinfo b/ilist.texinfo
index da9ec77dac..078b0e5e27 100644
--- a/ilist.texinfo
+++ b/ilist.texinfo
@@ -287,20 +287,14 @@ instead of nil, then?  Well, people make mistakes all the 
time, at
 least I do.  So I think this mechanism can help people to remember
 give a default label for elements.
 @item SORTER
-This can be a symbol, or an s-expression.
-
-If it is a symbol, it will be used as the sorting function of the
-group labels.  Note that one does not have to quote this symbol,
-though you can still quote it.
+This should be a function, or the symbol of a function.
 
 @cindex ilist-dag sorter convention
 
-If it is an s-expression., it will be used to define a function
-@code{ilist-automatic-group-NAME-sorter}, which then becomes the
-sorting function.  The variables @code{X} and @code{Y} are bound to
-the labels to sort in this expression.  The sorter function should
-return a non-nil value if and only if the group labelled @code{X}
-should be displayed before the group labelled @code{Y}.
+This will be used as the sorting function of the group labels.  The
+sorter function should accept two arguments, and should return a non-nil
+value if and only if the group labelled by the first argument should be
+displayed before the group labelled by the second argument.
 @end table
 
 @node Mapping over lines, Moving, Entry point, Top



reply via email to

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