Skip to content

fix README: fixed a couple of documentation mistakes #87

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

Merged
merged 2 commits into from
Aug 19, 2019

Conversation

weissi
Copy link
Contributor

@weissi weissi commented Aug 19, 2019

  • README suggested that you should shut down the client in a defer block right after calling get which will not actually work because the get is asynchronous so returns before it's done
  • README said that if you share the EventLoop you don't need to shut down the HTTPClient which is not true
  • README didn't make it clear that using HTTPClient(eventLoopGroupProvider: .createNew) is an acceptable thing to write in many places but it's really resource inefficient

- README suggested that you should shut down the client in a `defer` block right after calling `get` which will not actually work because the `get` is asynchronous so returns before it's done
- README said that if you share the `EventLoop` you don't need to shut down the `HTTPClient` which is not true
- README �didn't make it clear that using `HTTPClient(eventLoopGroupProvider: .createNew)` is an acceptable thing to write in many places but it's really resource inefficient
@weissi weissi requested a review from artemredkin August 19, 2019 13:30
@artemredkin artemredkin merged commit 6c6162b into master Aug 19, 2019
@artemredkin artemredkin deleted the jw-repair-readme branch August 19, 2019 13:37
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

Successfully merging this pull request may close these issues.

2 participants