What tools do people use for generating docs from clojure code?

cljdoc generates the documentation part automatically if you put your project on Clojar I believe

https://cljdoc.org/

I heard about marginalia also

https://github.com/gdeer81/marginalia

Never tried it, it seems to be kind of documentation generation/ literate programming type of library

On a tangent, I wonder if these tools could at some point make use of specs to enhance the documentation

cljdoc talk about it, it's in his roadmap

https://github.com/cljdoc/cljdoc/blob/master/doc/roadmap.adoc

It's goal is to try to do something akin to Hoogle => https://www.haskell.org/hoogle/

Research function based on their signature

Really cool feature for Haskell

That could probably be recreated for Clojure with the help of Spec

So many times while browsing docs, I ask "ok, but what does this opts map look like?"

https://www.martinklepsch.org/posts/writing-awesome-docstrings.html

Martin Klepsch advocates to use table in docstring to help understand what keys goes into opts map

That could help a lot!

It's funny because every questions you have here, I read about it like 2h ago

Do you have this week's lottery numbers too?

435 4585 744 but don't tell anyone else, that'll be our secret 😉 🤑

How do you compile clojure project into an uberjar using clj ?

A couple days ago I came here asking for help with exception handling happening within futures. I wrote up a little code to show what I was working with and I mistakingly didn't replicate the actual code verbatim. The real code looks like this

(def list-names '("Tom" "Harry" "Richard"))

(defn throw-func
  [nme]
  (str "hello " nme)
  (throw (Exception. "I just threw you an error")))

(defn tc-test
  []
  (let [futures (map (fn [name]
                       (let [sample (fn [name]
                                      (try
                                        (println "Sanity Check")
                                        #(throw-func name)
                                        (catch Exception e
                                          (println "Got an error here!"))))]
                         (future ((sample name)))))
                     list-names)
        response (doall (map deref futures))]
    1))

(defn foo
  []
  (try
    (tc-test)
    (catch Exception e
      (println "Handling error here as well"))))

I never saw the exception in sample because there was no exception happening when returning an anonymous function. So to fix I had to return the try-catch and call throw-func. Then everything worked as I expected it

Thanks for the doc generation links and Martin Klepsch’s article on writing good docs. I had just finished documenting a couple of functions but was curious if it would be beneficial to put the breakdown of map properties into the meta of a function and write a tool to use it to build more detailed docs. Right now it feels like a big ’ol string.

So something like (println "hello" name "!") automatically includes a space between operands. => hello chasote ! Seemed convenient at first but how do I get rid of the space if I don't want it?

(println (str "hello" name "!"))

simple enough! there will be a day when I'll be like, "why can't str just put the darn space in for me!" haha

hehe, its pretty common in other languages, JavaScript’s console.log, Pythons print(...) and such do the same ^^

Hi All. If I have a vector of vectors (with strings as they type of each of the four elements of the individual vectors), what would be the best way to go about combing vectors that have the same first element string value?

So [["hey" "1" "2" "3"] ["you" "4" "5" "6"] ["hey" "7" "8" "9"]] would return [["hey" "1" "2" "3" "7" 8" "9"] ["you" "4" "5" "6"]]

I am guessing this would be a good case for a loop, any opinions?

you might play with group-by first

that's just a first step

@alexmiller Thank you! I think this puts me on the right path.

be careful, you get a map from that, so if its important to you that “hey” stays before “you”, the order of the entries in a map is not guaranteed

Thank you for the heads-up @lennart.buit.

Hi guys, I was wondering if there is something along the lines of didSet in clojure? The use case I'm thinking of is: an atom is updated with a new value and then I want to fire some API request using the newValue