Commits

Anonymous committed f2ce1f7

Standardize documentation style

Comments (0)

Files changed (3)

src/lanterna/common.clj

 (defn block-on
   "Repeatedly apply func to args until a non-nil value is returned.
 
-  opts is a map optionally containing an :interval and a :timeout in msecs.
-    :interval sets the interval between function applications (default 50).
-    :timeout sets the maximum amount of time blocking will occur before
-    returning nil.
+  Options can include any of the following keys:
+
+  :interval - sets the interval between function applications (default 50)
+  :timeout  - sets the maximum amount of time blocking will occur before
+              returning nil
 
   "
   ([func args] (block-on func args {}))

src/lanterna/screen.clj

   If the user has *not* pressed a key, this function will block, checking every
   50ms.  If you want to return nil immediately, use get-key instead.
 
-  Optionally accepts :interval and :timeout &rest keyword arguments.
-    :interval sets the interval between checks.
-    :timeout sets the maximum amount of time blocking will occur before
-    returning nil.
+  Options can include any of the following keys:
+
+  :interval - sets the interval between checks
+  :timeout  - sets the maximum amount of time blocking will occur before
+              returning nil
 
   "
   ([^Screen screen] (get-key-blocking screen {}))

src/lanterna/terminal.clj

   If the user has *not* pressed a key, this function will block, checking every
   50ms.  If you want to return nil immediately, use get-key instead.
 
-  Optionally accepts :interval and :timeout &rest keyword arguments.
-    :interval sets the interval between checks.
-    :timeout sets the maximum amount of time blocking will occur before
-    returning nil.
+  Options can include any of the following keys:
+
+  :interval - sets the interval between checks
+  :timeout  - sets the maximum amount of time blocking will occur before
+              returning nil
 
   "
   ([^Terminal terminal] (get-key-blocking terminal {}))