with-gen should specify if the generator should return conformed or unformed data

Question

I think the answer is "unformed", but this isn't very clear from the docstring.

Answer 1

Comment made by: alexmiller

The answer is definitely unconformed. Conforming only happens when you call conform. This doesn't seem confusing to me, but maybe it should be clearer. I suspect it would be better to clarify this in a reference documentation page though.

Answer 2

Comment made by: lvh

I agree that a reference documentation change would be most helpful.

I rely heavily on my environment showing me docstrings, so a small point (maybe just unconformed/unformed/whatever in parens) in the docstring would still be helpful.

Answer 3

Reference: https://clojure.atlassian.net/browse/CLJ-2017 (reported by lvh)