summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2019-08-07 18:12:30 +0530
committerArun Isaac2019-08-07 18:12:30 +0530
commit88d5b26f058917c27b45569683ad8e875b23d569 (patch)
tree518e0cf450e168afd5de754b86cfd437b63b9e54
parente7bdbc816edb3f20559ba5645999655677fb3c52 (diff)
downloadguile-email-88d5b26f058917c27b45569683ad8e875b23d569.tar.gz
guile-email-88d5b26f058917c27b45569683ad8e875b23d569.tar.lz
guile-email-88d5b26f058917c27b45569683ad8e875b23d569.zip
utils: Clarify read-while docstring.
* email/utils.scm (read-while): Clarify docstring.
-rw-r--r--email/utils.scm8
1 files changed, 5 insertions, 3 deletions
diff --git a/email/utils.scm b/email/utils.scm
index 8344c6b..536dc52 100644
--- a/email/utils.scm
+++ b/email/utils.scm
@@ -43,9 +43,11 @@ list."
(cons x (read-objects read-proc port)))))
(define* (read-while port read-proc pred)
- "Read from PORT using READ-PROC while PRED returns #t. READ-PROC is
-invoked with the input port as argument. PRED is invoked with each
-string returned by READ-PROC as argument."
+ "Read from PORT using READ-PROC while PRED returns #t and the
+end-of-file has not been reached. READ-PROC is invoked with the input
+port as argument. PRED is invoked with each string returned by
+READ-PROC as argument. The string for which PRED returns #f is ungot
+back into PORT."
(define (read-while-loop output)
(let ((x (read-proc port)))
(cond