I expected a code smell response, but I simply don't agree with that. I believe 
peoples approach to doc strings are as varied as people are. I tend to be 
specific and want to add more context (do not read 'more content') in my doc 
string(s) than others might, but at the same time it's not like there's a 
shortage of poorly documented code in the world. So maybe we should consider 
other people's approach too. A simple solution might be to put the doc-string 
before the name:

i.e. Instead of:

defmulti the-name multi-fn

use:

defmulti "brevity matters in a doc-string" the-name multi-fn

Or

(defn 
"doc-string"
([x]...)
"doc-string"
([x y] ...))

Or is there a reason not to consider adding this?

Cheers,
Tim







-- 
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.

Reply via email to