Fork me on GitHub
#sci
<
2022-10-24
>
mhuebert20:10:46

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?

borkdude20:10:44

By default all vars get doc included, but perhaps some macros don't but this could be fixed I think

mhuebert20:10:16

^ oops I thought that would be somehow collapsed

mhuebert20:10:31

anyway that’s a list of non-private things that seem to be missing docs unless I’m doing it wrong

mhuebert20:10:23

a lot of macros but not only

borkdude20:10:05

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 :)

borkdude20:10:47

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

mhuebert20:10:28

one sec let me do this properly

mhuebert20:10:02

here: https://gist.github.com/mhuebert/72b6ee33e36c84754ae22205e6208bd8 these are things missing docs, which have docs in clojure.core

borkdude20:10:21

feel free to post this as an issue, so we can work through that list to get it fixed

borkdude20:10:35

and then followed by PRs to fix those

mhuebert20:10:40

sounds good

borkdude20:10:58

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

borkdude20:10:14

following back from namespaces.cljc should give you an idea where to add the docstring