Hi Tim,

You suggested a great reason yourself: "peoples approach to doc strings are
as varied as people are". To the extent that is true, someone would need to
propose a design considerate of that variety of needs (and tradeoffs!).
Without such planning, Clojure would evolve as a semi-random-walk of
itch-scratching. I have worked with tools that evolve this way and I am
thrilled that Clojure isn't one.

That said, Clojure is flexible enough that you could experiment with this
idea on your own and create a proof-of-concept requiring no change to core.
I am pretty sure you will encounter problems along the way. :-)

Cheers,
Stu



On Sun, Nov 5, 2017 at 10:24 AM, Tim <tcr1...@gmail.com> wrote:

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

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