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
^ oops I thought that would be somehow collapsed
anyway that’s a list of non-private things that seem to be missing docs unless I’m doing it wrong
a lot of macros but not only
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
one sec let me do this properly
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
and then followed by PRs to fix those
sounds good
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
etc
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