Is there a way to create doc strings on both interfaces (procotols, multi 
functions) and concrete implementations (protocol implementation, 
multi-methods)? For now it seems to me I can only have doc strings for the 
interfaces. If that is the case, I feel it is something worth fixing, 
because in my view doc string is not a nice-to-have thing, but essential 
for dynamic languages.

Assuming we don't have it yet, what I am hoping for is, when I do (doc 
symbol), or use slime-describe-symbol, it should list the doc strings for 
the interfaces along with the doc strings of all of its concrete 
implementations.

For example, I may have a multi-function like this:

(defmulti make-obj
  "Create a new obj."
  (fn [& args] (first args)))

This multi function dispatches on the first argument, and each method can 
have quite different argument list and of course doc strings. But for now I 
don't seem to have a way to document them.

Another thing I hope for (but less important), is to be able to have 
different doc strings for different signatures of the same function. 

I think computer language is called "language" for a reason. It is not just 
for making computers to do magic things, but also be able to let people 
(youself in 4 months or another programmer) to under how that magic 
happens. It is a communication media like a natural language, and doc 
strings are even more important here because dynamic languages are so 
"dynamic".

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

Reply via email to