Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

consider using spec fdef to autogenerate examples #5

Open
carocad opened this issue Jul 21, 2018 · 0 comments
Open

consider using spec fdef to autogenerate examples #5

carocad opened this issue Jul 21, 2018 · 0 comments

Comments

@carocad
Copy link

carocad commented Jul 21, 2018

Hey Zach,

to be honest I have never used your project but I came here since it was mentioned in an expound issue.

I checked your docs generation and they seem really nice, which made me wonder if you have considered creating examples automatically.

You are already creating docs automatically so why not the examples? 😄

With the introduction of clojure spec it is possible to "instrument" functions and through that both arguments and return values can be determined.

Since it is (generally) possible to get a generator for a clojure spec I think it should be possible to generate an example based on an instrumented function

Hope it helps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant