From c578e31ae2a2eb88ab9dce1635d28b5ac0125baf Mon Sep 17 00:00:00 2001
From: Andrey Antukh <niwi@niwi.nz>
Date: Mon, 9 Sep 2024 12:24:14 +0200
Subject: [PATCH] :paperclip: Update some docstrings on common/schema ns

---
 common/src/app/common/schema.cljc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/common/src/app/common/schema.cljc b/common/src/app/common/schema.cljc
index 2f28fc946..7c73bb6a0 100644
--- a/common/src/app/common/schema.cljc
+++ b/common/src/app/common/schema.cljc
@@ -221,6 +221,8 @@
           (v/-block "Schema" (v/-visit schema printer) printer)]})
 
 (defn pretty-explain
+  "A helper that allows print a console-friendly output for the
+  explain; should not be used for other purposes"
   [explain & {:keys [variant message]
               :or {variant ::explain
                    message "Validation Error"}}]
@@ -253,6 +255,7 @@
 
 (declare ^:private lazy-schema)
 
+;; DEPRECATED: should not be used for new code
 (defn check-fn
   "Create a predefined check function"
   [s]