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

defnk-defined functions don't document their args #118

Open
gfredericks opened this issue Mar 8, 2016 · 1 comment
Open

defnk-defined functions don't document their args #118

gfredericks opened this issue Mar 8, 2016 · 1 comment

Comments

@gfredericks
Copy link
Contributor

When you defnk something clojure.repl/doc can't find any info about the args the function takes.

When I started thinking about this I realized it's not obvious what the best solution is here; perhaps the :arglists metadata could be generated that would reflect a normal top-level destructuring form such as [{:keys [foo bar baz]}]? It wouldn't have complete information but feels like it'd be better than nothing.

@w01fe
Copy link
Member

w01fe commented Mar 9, 2016

Thanks for the suggestion. That sounds reasonable to me -- so long as the arglist is accurate (says as much about the args as it can without saying anything false) it definitely seems better than nothing. PR welcome!

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

2 participants