This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2019-06-18
Channels
- # aws (12)
- # beginners (489)
- # calva (32)
- # cider (117)
- # clj-kondo (4)
- # cljdoc (9)
- # cljs-dev (3)
- # clojure (56)
- # clojure-brasil (1)
- # clojure-europe (10)
- # clojure-italy (44)
- # clojure-nl (9)
- # clojure-russia (1)
- # clojure-sweden (6)
- # clojure-uk (64)
- # clojurescript (6)
- # cursive (6)
- # datascript (4)
- # datomic (6)
- # emacs (3)
- # fulcro (15)
- # graalvm (11)
- # jackdaw (7)
- # jobs (8)
- # jobs-discuss (29)
- # jvm (2)
- # leiningen (5)
- # luminus (10)
- # off-topic (23)
- # pathom (21)
- # planck (11)
- # quil (6)
- # re-frame (11)
- # reagent (17)
- # reitit (8)
- # rewrite-clj (6)
- # shadow-cljs (78)
- # slack-help (2)
- # spacemacs (7)
- # specter (4)
- # sql (60)
- # tools-deps (7)
- # xtdb (11)
@martinklepsch I happened to notice that one of my next.jdbc
namespaces doesn't make it into the nav tree on the left (because it has no vars) https://cljdoc.org/d/seancorfield/next.jdbc/1.0.0/api/next.jdbc.connection -- I wondered if there was an option in cljdoc via metadata to force inclusion of a namespace?
The decision of not showing "empty" namespaces in the navigation was made ad-hoc and could be revisited. Do you have any thoughts on that general decision? @seancorfield
@seancorfield you can preview cljdoc docs on your own machine (e.g. via Docker): https://github.com/cljdoc/cljdoc/blob/master/doc/running-cljdoc-locally.md#running-locally-with-docker this prevented surprises before I deployed my libs a few times
@martinklepsch it's a perfectly reasonable default. A metadata option on the ns to override it would be nice. Not a big deal. I definitely think "empty" namespaces are an edge case.
I’m also curious why you would want a namespace without vars to be documented. what is the reason for its existence?
@borkdude It has implementations of protocols so it's "important" from that point of view but the only docstring in it, I think, is on the ns
itself.
(it also contains a bunch of private vars and functions that support those implementations)