This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2019-10-16
Channels
- # announcements (7)
- # babashka (1)
- # beginners (25)
- # calva (7)
- # cider (15)
- # clj-kondo (13)
- # cljdoc (14)
- # clojure (151)
- # clojure-europe (4)
- # clojure-hamburg (2)
- # clojure-italy (22)
- # clojure-nl (57)
- # clojure-spec (12)
- # clojure-uk (6)
- # clojuredesign-podcast (5)
- # clojurescript (12)
- # core-async (8)
- # cursive (26)
- # datascript (9)
- # datomic (92)
- # emacs (4)
- # fulcro (7)
- # graalvm (1)
- # graphql (2)
- # instaparse (3)
- # jobs (1)
- # jvm (2)
- # kaocha (6)
- # nrepl (3)
- # off-topic (5)
- # re-frame (45)
- # reagent (5)
- # reitit (18)
- # ring (1)
- # shadow-cljs (89)
- # slack-help (9)
- # spacemacs (2)
- # sql (54)
- # tools-deps (75)
- # vim (28)
- # xtdb (17)
- # yada (31)
out of curiosity: does cljdoc also show javadocs for java sources in clojure projects?
@borkdude not in scope, sorry!
Happy to discuss if you feel there’s a strong case for it but my intuition is that cost/benefit just doesn’t make much sense given the average Clojure library
Generating documentation to markdown files 👌 😄 Boot does that too, worked pretty well
@martinklepsch hello 🙂 I was having the wish to have some attribute documentation on cljdoc, in that I mean, having a section of the docs dedicated to talk about the keywords with spec information, this could include:
1. list of qualified keywords are used in the project (maybe even those without spec)
2. describe specs for keywords that have it
3. using data from fspec
/ fdef
it could generate a list of functions where that keyword is mentioned
I have done something similar for Pathom (https://wilkerlucio.github.io/pathom/v2/pathom/2.2.0/connect/exploration.html). what do you think about having something like this in cljdoc?
Could also have inline example generation for specced stuff.
@wilkerlucio Couldn't you just write that up in the doc
folder in your repo?
https://cljdoc.org/d/seancorfield/next.jdbc/1.0.9/doc/getting-started is an example of docs generated from https://github.com/seancorfield/next-jdbc/blob/master/doc/getting-started.md
Oh, you specifically want it auto-generated from the source?
I'm not sure how valuable auto-generated data would be -- I would expect it to need more curation?