From e1b1abe2dea1787ebca86f48636e90c917bc8ba6 Mon Sep 17 00:00:00 2001
From: Nick Alexander <nalexander@mozilla.com>
Date: Tue, 11 Oct 2016 20:21:48 -0700
Subject: [PATCH] Pre: clarify comments.

---
 src/common/datomish/db.cljc | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/src/common/datomish/db.cljc b/src/common/datomish/db.cljc
index 3fe7107d..f0d9c0d5 100644
--- a/src/common/datomish/db.cljc
+++ b/src/common/datomish/db.cljc
@@ -111,9 +111,12 @@
 
   (in-transaction!
     [db chan-fn]
-    "Evaluate the given pair-chan `chan-fn` in an exclusive transaction. If it returns non-nil,
-    commit the transaction; otherwise, rollback the transaction.  Returns a pair-chan resolving to
-    the pair-chan returned by `chan-fn`.")
+    "Evaluate the given `chan-fn` in an exclusive transaction. If it returns non-nil,
+    commit the transaction; otherwise, rollback the transaction.
+
+    `chan-fn` should be a function of no arguments returning a pair-chan.
+
+    Returns a pair-chan resolving to the same pair as the pair-chan returned by `chan-fn`.")
 
   (<bootstrapped? [db]
     "Return true if this database has no transactions yet committed.")
@@ -818,14 +821,14 @@
    (<?q db find {}))
   ([db find options]
    (let [unexpected (seq (clojure.set/difference (set (keys options)) #{:limit :order-by :inputs}))]
-    (when unexpected
-      (raise "Unexpected options: " unexpected {:bad-options unexpected})))
+     (when unexpected
+       (raise "Unexpected options: " unexpected {:bad-options unexpected})))
    (let [{:keys [limit order-by inputs]} options
          parsed (query/parse find)
          context (-> db
-                   query-context
-                   (query/options-into-context limit order-by)
-                   (query/find-into-context parsed))
+                     query-context
+                     (query/options-into-context limit order-by)
+                     (query/find-into-context parsed))
 
          ;; We turn each row into either an array of values or an unadorned
          ;; value. The row-pair-transducer does this work.