From: Christopher Allan Webber <cwebber@dustycloud.org>
Date: Fri, 20 Nov 2015 17:27:10 +0000 (-0600)
Subject: moar docstrings
X-Git-Tag: v0.1.0~129
X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=ceed07c211d0ca9812bf36eff48a2692edc7b5eb;p=8sync.git

moar docstrings
---

diff --git a/loopy.scm b/loopy.scm
index 603a75a..1c26a2f 100644
--- a/loopy.scm
+++ b/loopy.scm
@@ -87,6 +87,8 @@
                       (except-port-map (make-hash-table))
                       (schedule (make-schedule))
                       (time (gettimeofday)))
+  ;; TODO: document arguments
+  "Make a fresh agenda."
   (make-agenda-intern queue prompt
                       read-port-map write-port-map except-port-map
                       schedule time))
@@ -351,6 +353,7 @@ Will produce (0 . 0) instead of a negative number, if needed."
 (define %current-agenda (make-parameter #f))
 
 (define (update-agenda-from-select! agenda)
+  "Potentially (select) on ports specified in agenda, adding items to queue"
   (define (hash-keys hash)
     (hash-map->list (lambda (k v) k) hash))
   (define (get-wait-time)
@@ -429,6 +432,8 @@ Will produce (0 . 0) instead of a negative number, if needed."
                        #:key stop-condition
                        (get-time gettimeofday)
                        (handle-ports update-agenda-from-select!))
+  ;; TODO: Document fields
+  "Start up the AGENDA"
   (let loop ((agenda agenda))
     (let ((agenda   
            ;; @@: Hm, maybe here would be a great place to handle