Adding examples to error messages about expound HOT 4 CLOSED

@jefffriesen It's a good idea! I do think examples would be really useful in this context, especially for beginners who may have less familiarity with the spec syntax.

This isn't well documented in Expound currently (hmm, maybe I need to use Dynadoc to document the API 😄 ), but it's possible to modify the default Expound printer, so any user could add extra info like the defexample to the output.

Unfortunately, right now the information that spec returns does not include the symbol of the function that was called, so there is no way to look up the example (which requires knowing the namespace and function name). The issue tracking this is https://dev.clojure.org/jira/browse/CLJ-2166 (please log in and vote for it! 😄 )

Once that fix makes it into Clojure spec, I will write up some example code of how to include examples defined via defexample. At some point in the future, I may include this by default, or at least as an option in Expound. I'm hesitant to add dependencies until it's clear that most users would like the functionality built in. Let's leave this issue open for now and see if it attracts upvotes 😄 .

from expound.

Sounds like a great plan.
(I've voted for that Jira issue 😄)

from expound.

FYI https://dev.clojure.org/jira/browse/CLJ-2166 has been resolved on 2018-06-26 and is available in clojure.spec release 0.2.168

from expound.

Thanks again for the idea! Since I haven't seen a wide adoption of examples, I'm going to close this for now. If examples turn up in say, cljdoc and more people use them, I'd reconsider, but for now, I'm not inclined to add an additional dependency on expound.

from expound.