Yeah, I saw the same video and wanted to do something to start help improving the documentation also. I remember the time when I was trying to get into clojure. It was hard to make heads or tails out of the official api docs.
Regarding the syntactic format of the documentation, wouldn't something like markdown (or friends) be sufficient? It's readable in ascii form and easy to make presentable in html form. What were some of the discussion points around the format of the docstring? On Friday, September 8, 2017 at 4:55:32 PM UTC+8, Matching Socks wrote: > > The question of markup has tended to attract many far-sighted suggestions > that turn it into a bike shed. Luckily, the undertaking needs no blessing. > > Clojure's doc strings change infrequently, if ever! Someone may set forth > a markup language and create a fork with marked-up doc strings, and > tool-wrights may substitute them for the matching unmarked originals on the > fly. > > Perhaps if done consistently with the Contributor Agreement the markup > could eventually be merged in, but, on the other hand, perhaps lasting > advantages would be found in the outboard arrangement. > -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
