Karsten Schmidt avatar Karsten Schmidt committed e6db3bc

updating doc strings

Comments (0)

Files changed (1)

src/macrochrono.clj

   {:author "Karsten Schmidt"})
 
 (defmacro timed-action
-  "Evaluates body in a do form and measures execution time.
-  Returns result as 2-element vector: [body-result time-in-msecs]"
+  "Evaluates `body` in a do form and measures execution time.
+  Returns result as 2-element vector: `[body-result time-in-msecs]`"
   [& body]
   `(let [t0# (System/nanoTime)]
      [(do ~@body) (* 1e-6 (- (System/nanoTime) t0#))]))
 
 (defmacro bench
-  "Evaluates body num times and returns map of execution time statistics:
+  "Evaluates `body` `num` times and returns map of execution time statistics:
   average, min, max and median times (all in ms). The result of the body
-  expression is discarded. If verbose? is truthy, each intermediate timing
-  is printed to *out*."
+  expression is discarded. If `verbose?` is truthy, each intermediate timing
+  is printed to `*out*`."
   ([num body] `(bench ~num ~body false))
   ([num body verbose?]
   `(loop [stats# [] i# ~num]
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.