[elpa] externals/el-search 816e675 033/332: document el-search--do-subsexps

[Stefan Monnier]

branch: externals/el-search
commit 816e675741d91e4e429d3403eb4e5c31ec11e85b
Author: Michael Heerdegen <michael_heerdegen@web.de>
Commit: Michael Heerdegen <michael_heerdegen@web.de>

    document el-search--do-subsexps
---
 el-search.el | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/el-search.el b/el-search.el
index e7786c1..8eb328e 100644
--- a/el-search.el
+++ b/el-search.el
@@ -351,7 +351,11 @@ return nil (no error)."
     match-beg))
 
 (defun el-search--do-subsexps (pos do-fun &optional ret-fun bound)
-  ;; bound -> nil means till end of buffer
+  ;; In current buffer, for any expression start between POS and BOUND
+  ;; or (point-max), in oder, call two argument function DO-FUN with
+  ;; the current sexp string and the ending position of the current
+  ;; sexp.  When done, with RET-FUN given, call it with no args and
+  ;; return the result; else, return nil.
   (save-excursion
     (goto-char pos)
     (condition-case nil