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

Clarify documentation regarding "arguments" passed into Droplet initializer #812

Closed
mz2 opened this issue Feb 2, 2017 · 2 comments
Closed

Comments

@mz2
Copy link
Contributor

mz2 commented Feb 2, 2017

At https://vapor.github.io/documentation/testing/basic.html there's a following statement made about setting up a Droplet for testing:

Droplet(arguments: ["dummy/path/", "prepare"], ...
The arguments: parameter in our Droplet creation. This is rarely used except for advanced situations, but we'll use it here in testing to ensure that our Droplet doesn't try to automatically serve and block our thread. You can use arguments besides "prepare", but unless you're doing something specific for an advanced situation, these arguments should suffice.

It would be helpful if the documentation here, and also in Droplet initialization, would explicitly make it clear that the 1st argument in that argument list maps to the argv passed into the app (and such the first argument is the executable name – therefore it's just "dummy/path" when you initialize a Droplet in context of tests).

@tanner0101
Copy link
Member

Moved to vapor/documentation.

@mz2
Copy link
Contributor Author

mz2 commented Feb 2, 2017

Ah, sorry. Will make sure to file there next time.

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