docs: add documentation to functions

kepler16 · Jun 10, 2022 · 4acb111 · 4acb111
1 parent 210ecec
commit 4acb111
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/k16/gx/beta/error_context.clj b/src/k16/gx/beta/error_context.clj
@@ -1,6 +1,7 @@
 (ns k16.gx.beta.error-context)
 
 (defmacro with-err-ctx
+  "Creates error context by merging value to `k16.gx.beta.error/*err-ctx*`"
   [ctx & body]
   `(binding [~'k16.gx.beta.errors/*err-ctx*
              (merge ~'k16.gx.beta.errors/*err-ctx* ~ctx)]

diff --git a/src/k16/gx/beta/errors.cljc b/src/k16/gx/beta/errors.cljc
@@ -3,6 +3,7 @@
 (defrecord ErrorContext [error-type node-key node-contents signal-key])
 
 (def ^:dynamic *err-ctx*
+  "Error context is used for creating/throwing exceptions with contextual data"
   (map->ErrorContext {:error-type :general}))
 
 (defn gx-err-data