From 88d5b26f058917c27b45569683ad8e875b23d569 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Wed, 7 Aug 2019 18:12:30 +0530
Subject: utils: Clarify read-while docstring.

* email/utils.scm (read-while): Clarify docstring.
---
 email/utils.scm | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'email')

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
-- 
cgit v1.2.3