Attach see-also metadata to special syms

Author: bbatsov

src/orchard/clojuredocs.clj

@@ -88,3 +88,12 @@
    (find-doc ns sym default-edn-file-url))
   ([ns sym export-edn-url]
    (get-doc (keyword ns sym) export-edn-url)))
+
+(defn- kw-to-sym [kw]
+  (symbol (subs (str kw) 1)))
+
+(defn see-also
+  "Get the see-alsos for `var-name` if any."
+  [var-name]
+  (if-let [see-alsos (:see-alsos (get-doc var-name))]
+    (map kw-to-sym see-alsos)))

src/orchard/meta.clj

@@ -73,8 +73,8 @@
 (defn- maybe-add-see-also
   "If the var `v` has a see-also has associated with it, assoc that into meta-map."
   [v meta-map]
-  (if-let [see-also (:see-alsos (cljdocs/get-doc (var-name v)))]
-    (merge meta-map {:see-also (map symbol see-also)})
+  (if-let [see-also (cljdocs/see-also (var-name v))]
+    (merge meta-map {:see-also see-also})
     meta-map))
 
 (defn- maybe-protocol
@@ -151,6 +151,7 @@
     (when-let [m (and compiler-special? (repl-special-meta sym))]
       (-> m
           (assoc :name orig-sym)
+          (assoc :see-also (cljdocs/see-also (format "clojure.core/%s" sym)))
           maybe-add-url))))
 
 (def var-meta-whitelist

test/orchard/meta_test.clj

@@ -62,6 +62,9 @@
     (is (= 'catch (:name (m/special-sym-meta 'catch))))
     (is (= 'finally (:name (m/special-sym-meta 'finally)))))
 
+  (testing ":see-also metadata is attached"
+    (is (not-empty (:see-also (m/special-sym-meta 'if)))))
+
   (testing "Name is correct for `clojure.core/import*`"
     ;; Only compiler special to be namespaced
     (is (= 'clojure.core/import* (:name (m/special-sym-meta 'clojure.core/import*)))))