finish docstring

[8sync.git] / 8sync / inbox.scm

diff --git a/8sync/inbox.scm b/8sync/inbox.scm
index bf1eabc1a3fb8a9c3607e01384b3bfdd63c0b46b..fbf8df08222310dfd2b74c4d6c8a088f9b54d62e 100644 (file)
--- a/8sync/inbox.scm
+++ b/8sync/inbox.scm
@@ -27,10 +27,12 @@
   #:use-module (ice-9 atomic)
   #:export (delivery-agent))
 
+;; TODO: Add backpressure limit
 (define (delivery-agent inbox-enq inbox-deq stop?)
   "This starts up a loop doing delivery receiving from INBOX-ENQ and
-delivering to INBOX-DEQ, actually managing an (ice-9 q) object QUEUE.
-Atomic box STOP? can be set to indicate that this "
+delivering to INBOX-DEQ, actually managing an internal object QUEUE.
+Condidtion variable STOP? can be set to indicate that this agent
+should stop."
   (define queue
     (make-q))
   (define get-or-stop