#822: more docstrings

babashka · Nov 1, 2022 · 70fba0c · 70fba0c
1 parent 4b7d7cf
commit 70fba0c
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 7 deletions.
diff --git a/src/sci/impl/namespaces.cljc b/src/sci/impl/namespaces.cljc
@@ -951,8 +951,7 @@
     ;; end IDeref as protocol
     ;; IAtom / ISwap as protocol
     'swap! (new-var 'swap! core-protocols/swap!*)
-    'compare-and-set! #?(:clj (new-var 'compare-and-set!
-                                        core-protocols/compare-and-set!*)
+    'compare-and-set! #?(:clj (copy-var core-protocols/compare-and-set!* clojure-core-ns {:name 'compare-and-set!})
                          :cljs (copy-core-var compare-and-set!))
     #?@(:cljs ['IReset core-protocols/reset-protocol
                'ISwap core-protocols/swap-protocol

diff --git a/src/sci/impl/utils.cljc b/src/sci/impl/utils.cljc
@@ -255,9 +255,15 @@
 
 (def clojure-core-ns (lang/->Namespace 'clojure.core nil))
 
-(def current-file (dynamic-var '*file* nil {:ns clojure-core-ns}))
-
-(def current-ns (dynamic-var '*ns* user-ns {:ns clojure-core-ns}))
+(def current-file
+  (dynamic-var '*file* nil
+               {:doc "The path of the file being evaluated, as a String.\n\n  When there is no file, e.g. in the REPL, the value is not defined."
+                :ns clojure-core-ns}))
+
+(def current-ns
+  (dynamic-var '*ns* user-ns
+               {:ns clojure-core-ns
+                :doc "A sci.lang.Namespace object representing the current namespace."}))
 
 (defn current-ns-name []
   (t/getName @current-ns))

diff --git a/test/sci/namespaces_test.cljc b/test/sci/namespaces_test.cljc
@@ -324,7 +324,8 @@ bar/bar"}
     (doseq [v '[*print-namespace-maps*
                 *print-dup*
                 *print-readably*
-                *1 *2 *3 *e]]
+                *1 *2 *3 *e
+                *file* *ns*]]
       (is (true? (eval* (str/replace "(string? (:doc (meta #'{{v}})))" "{{v}}" (str v)))) v)))
   (testing "regular vars (with possibly alternative impls)"
     (doseq [v `[inc
@@ -337,7 +338,8 @@ bar/bar"}
                 #?(:clj reset-vals!)
                 alength
                 #?(:clj var-get)
-                #?(:clj var-set)]
+                #?(:clj var-set)
+                compare-and-set!]
             :when v]
       (is (true? (eval* (str/replace "(string? (:doc (meta #'{{v}})))" "{{v}}" (str v)))) v))))