sci

2022-10-24T20:03:46.610269Z

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?

borkdude 2022-10-24T20:04:44.129129Z

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

2022-10-24T20:22:16.739309Z

^ oops I thought that would be somehow collapsed

2022-10-24T20:22:31.535669Z

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

2022-10-24T20:23:23.902889Z

a lot of macros but not only

borkdude 2022-10-24T20:25:05.042569Z

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

borkdude 2022-10-24T20:26:47.360089Z

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

2022-10-24T20:27:28.791369Z

one sec let me do this properly

2022-10-24T20:29:02.324039Z

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

borkdude 2022-10-24T20:32:21.901679Z

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

borkdude 2022-10-24T20:33:35.626959Z

and then followed by PRs to fix those

2022-10-24T20:34:40.705609Z

sounds good

borkdude 2022-10-24T20:34:58.198809Z

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

borkdude 2022-10-24T20:35:57.894829Z

for *print-readably* , adding a {:doc ...} here: https://github.com/babashka/sci/blob/09b269c242db8af20edde575b1827a2b86027411/src/sci/impl/io.cljc#L52

borkdude 2022-10-24T20:35:58.902069Z

etc

borkdude 2022-10-24T20:36:14.835629Z

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

2022-10-24T21:04:32.490839Z

thanks for the pointers! https://github.com/babashka/sci/issues/822