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

Document the signature of swagger_controller #161

Open
skatenerd opened this issue Apr 4, 2017 · 0 comments
Open

Document the signature of swagger_controller #161

skatenerd opened this issue Apr 4, 2017 · 0 comments

Comments

@skatenerd
Copy link

From reading the examples in the readme, I can't figure out the meaning of the first argument passed to swagger_controller. This first argument is a :symbol, whose name is similar to, but not always the same as, the name of the controller being documented. Beyond that, I'm not sure what it does.

I've experimented with passing in an arbitrary value, such as :zzzzzzzzzz, but thereafter, the string "zzzzzzzzzz" never appears in the generated documentation. Maybe my app is too simple, but it seems like the argument is being ignored?

Also, from a cursory glance at the source code, I haven't found an obvious instance where the value is being used.

Whatever the purpose of this argument is, it would help to document it in the readme.

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