3 ms·
I barely know it, but my brief experience with clojure has inspired me on how documentation should work. Ex. https://clojuredocs.org/clojure.core/reduce https:
by Gunax 5y ago
I barely know it, but my brief experience with clojure has inspired me on how documentation should work.
Ex. https://clojuredocs.org/clojure.core/reduce https://clojuredocs.org/clojure.core/reduce
The pattern is definition -> description -> community examples.
If I ever invent a language I am copying this format.
- blakesley 5y agoThat works for one-offs, but becomes a problem when you're working with a set of interrelated features, like a class. There, the very first thing I need is a high-level overview, not a reference. Of course, the reference is still useful for those who are familiar with the thing at hand.
- kqr 5y agoIsn't that basically the PHP model? Which isn't to say it's bad, I remember it as quite exhaustive: https://www.php.net/manual/en/function.strptime.php https://www.php.net/manual/en/function.strptime.php