This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2022-10-24
Channels
- # aws (2)
- # babashka (27)
- # beginners (97)
- # calva (1)
- # cherry (12)
- # cider (6)
- # clara (12)
- # clj-kondo (24)
- # clj-on-windows (4)
- # cljfx (14)
- # clojure (54)
- # clojure-australia (3)
- # clojure-europe (26)
- # clojure-nl (1)
- # clojure-norway (4)
- # clojure-uk (9)
- # clojurescript (65)
- # conjure (5)
- # cursive (7)
- # datomic (18)
- # emacs (6)
- # helix (2)
- # honeysql (1)
- # jobs (1)
- # joyride (15)
- # kaocha (2)
- # lsp (10)
- # malli (5)
- # nbb (12)
- # observability (5)
- # off-topic (5)
- # reitit (2)
- # releases (4)
- # ring (1)
- # sci (17)
- # shadow-cljs (34)
- # testing (29)
- # tools-deps (45)
- # vim (7)
- # xtdb (6)
Working on the “eldoc” functionality for Maria and digging into var metadata for built-in stuff. I was wondering how it is determined which vars for stuff in clojure.core get :doc
included?
By default all vars get doc included, but perhaps some macros don't but this could be fixed I think
anyway that’s a list of non-private things that seem to be missing docs unless I’m doing it wrong
Some of those things don't have docstrings in CLJS either. e.g. chunk-append
. I'd appreciate it you could post that list in a thread or so to not flood the channel :)
I think it's best to look at this on a case by case basis. There could be 2 things going on: 1. there is no docstring in CLJS either 2. it's a macro or something that has been patched in SCI
here: https://gist.github.com/mhuebert/72b6ee33e36c84754ae22205e6208bd8 these are things missing docs, which have docs in clojure.core
feel free to post this as an issue, so we can work through that list to get it fixed
e.g. for intern
I think it would just be matter of adding the docstring to this defn
https://github.com/babashka/sci/blob/master/src/sci/impl/namespaces.cljc#L506
for *print-readably*
, adding a {:doc ...}
here:
https://github.com/babashka/sci/blob/09b269c242db8af20edde575b1827a2b86027411/src/sci/impl/io.cljc#L52
following back from namespaces.cljc
should give you an idea where to add the docstring
thanks for the pointers! https://github.com/babashka/sci/issues/822