cljsinfo / cljs.info

ClojureScript website
http://cljs.info
MIT License
96 stars 9 forks source link

Docs missing some cljs.core public functions (eg, array-seq) #73

Open jdwaterson opened 8 years ago

jdwaterson commented 8 years ago

Just noticed that there are at least a couple of public functions in cljs.core that aren't documented anywhere in cljs.info. It was array-seq that brought this to my attention, but whilst looking at the source for cljs.core (https://github.com/clojure/clojurescript/blob/master/src/main/cljs/cljs/core.cljs), I can instantly see that there is also at least prim-seq in the same category. I haven't done an exhaustive search; there may be others.

I realise that this might be deliberate. Perhaps there is no desire to document every public, core function, and instead the aim is to apply some value judgement as to what is most important. That's essentially fine by me, if that's the case (although array-seq does seem reasonably important for JS interop).

But thought I should at least report it in case these two had just been overlooked somehow.

shaunlebron commented 8 years ago

thanks, I wasn't aware of these functions. The scope of the cheatsheet is still undecided. But the API docs are comprehensive (though they are not hosted on cljs.info yet):

If you'd like, you can contribute examples or descriptions at the bottom of those pages. Let me know if the process makes sense.