branch: externals/ilist
commit 8b5d5f382f5619fb8d02a27958b4f20d50ba0496
Author: JSDurand <mmem...@gmail.com>
Commit: JSDurand <mmem...@gmail.com>
Update docs
* README.org:
* ilist.info:
* ilist.pdf:
* ilist.texinfo: Update documentions.
---
README.org | 6 ++++--
ilist.info | 13 ++++++++-----
ilist.pdf | Bin 166377 -> 167330 bytes
ilist.texinfo | 7 +++++--
4 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/README.org b/README.org
index bb9c2de9d5..a75ab71ab1 100644
--- a/README.org
+++ b/README.org
@@ -95,7 +95,7 @@ auxiliary functions to operate on the displayed list. One is
=ilist-map-lines=. It is called as follows.
#+begin_src emacs-lisp :eval no :exports code
- (ilist-map-lines FUN PREDICATE START END)
+ (ilist-map-lines FUN PREDICATE START END NO-SKIP-INVISIBLE)
#+end_src
- FUN: The function to execute on each matching line.
@@ -103,13 +103,15 @@ auxiliary functions to operate on the displayed list.
One is
executed on each line. If it returns non-nil, that line is
considered to be matched.
- START and END limit the range of the mapping.
+- If NO-SKIP-INVISIBLE is non-nil, then we don’t skip invisible lines.
* Moving
It might be desired to move between the displayed list items in a
/cyclic/ manner, that is, assuming the top of the buffer is identified
with the bottom of the buffer. So the package provides four functions
-for moving.
+for moving. If the argument =NO-SKIP-INVISIBLE= is non-nil, then we
+don’t skip invisible lines.
- =ilist-backward-line=
- =ilist-forward-line=: Move between lines. One can control whether
diff --git a/ilist.info b/ilist.info
index 727c745346..2cb4056abb 100644
--- a/ilist.info
+++ b/ilist.info
@@ -192,7 +192,7 @@ For the convenience of package-users, this package also
provides some
auxiliary functions to operate on the displayed list. One is
'ilist-map-lines'. It is called as follows.
- (ilist-map-lines FUN PREDICATE START END)
+ (ilist-map-lines FUN &optional PREDICATE START END NO-SKIP-INVISIBLE)
'FUN'
The function to execute on each matching line.
@@ -203,6 +203,8 @@ auxiliary functions to operate on the displayed list. One
is
'START'
'END'
They limit the range of the mapping.
+'NO-SKIP-INVISIBLE'
+ If non-nil, then we don’t skip invisible lines.
File: ilist.info, Node: Moving, Next: Copying This Manual, Prev: Mapping
over lines, Up: Top
@@ -213,7 +215,8 @@ File: ilist.info, Node: Moving, Next: Copying This
Manual, Prev: Mapping over
It might be desired to move between the displayed list items in a
_cyclic_ manner, that is, assuming the top of the buffer is identified
with the bottom of the buffer. So the package provides four functions
-for moving.
+for moving. If the argument 'NO-SKIP-INVISIBLE' is non-nil, then we
+don’t skip invisible lines.
'ilist-backward-line'
'ilist-forward-line'
@@ -722,9 +725,9 @@ Node: Groups3694
Node: Fixed groups3995
Node: Automatic groups (planned)4856
Node: Mapping over lines5660
-Node: Moving6306
-Node: Copying This Manual6913
-Node: Index32021
+Node: Moving6409
+Node: Copying This Manual7103
+Node: Index32211
End Tag Table
diff --git a/ilist.pdf b/ilist.pdf
index bac835fb29..6249f32d58 100644
Binary files a/ilist.pdf and b/ilist.pdf differ
diff --git a/ilist.texinfo b/ilist.texinfo
index f5eafedad1..62f77d20db 100644
--- a/ilist.texinfo
+++ b/ilist.texinfo
@@ -196,7 +196,7 @@ auxiliary functions to operate on the displayed list. One
is
@code{ilist-map-lines}. It is called as follows.
@lisp
-(ilist-map-lines FUN PREDICATE START END)
+(ilist-map-lines FUN &optional PREDICATE START END NO-SKIP-INVISIBLE)
@end lisp
@table @code
@@ -209,6 +209,8 @@ matched.
@item START
@itemx END
They limit the range of the mapping.
+@item NO-SKIP-INVISIBLE
+If non-nil, then we don’t skip invisible lines.
@end table
@node Moving, Copying This Manual, Mapping over lines, Top
@@ -218,7 +220,8 @@ They limit the range of the mapping.
It might be desired to move between the displayed list items in a
@emph{cyclic} manner, that is, assuming the top of the buffer is
identified with the bottom of the buffer. So the package provides
-four functions for moving.
+four functions for moving. If the argument @code{NO-SKIP-INVISIBLE}
+is non-nil, then we don’t skip invisible lines.
@table @code
@item ilist-backward-line
