better documentation for MultiThreadedEventLoopGroup #582
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lukasa
requested changes
Aug 17, 2018
Sources/NIO/EventLoop.swift
Outdated
| /// - warning: Unit tests often spawn one `MultithreadedEventLoopGroup` per unit test to force isolation between the | ||
| /// tests. In those cases it's important to shut the `MultithreadedEventLoopGroup` down at the end of the | ||
| /// test. A good place to start a `MultithreadedEventLoopGroup` is the `setUp` method of your `XCTestCase` | ||
| /// subclass, a good place to shut it down is the `tearDown` method. |
There was a problem hiding this comment.
Nit: a number of the references to the name of this class in this block have incorrect casing. The correct casing is MultiThreadedEventLoopGroup. Mind fixing those up?
Sources/NIO/EventLoop.swift
Outdated
| @@ -920,7 +937,14 @@ final public class MultiThreadedEventLoopGroup: EventLoopGroup { | |||
| } | |||
| } | |||
|
|
|||
| public func shutdownGracefully(queue: DispatchQueue, _ callback: @escaping (Error?) -> Void) { | |||
| /// Shut this `MultithreadedEventLoopGroup` down which causes the `EventLoop`s and their associated threads to be | |||
There was a problem hiding this comment.
Nit: you have the same casing problem here.
Sources/NIO/EventLoop.swift
Outdated
| /// shut down and release their resources. | ||
| /// | ||
| /// - parameters: | ||
| /// - queue: The `DispatchQueue` to run `handler` on when the shutdown operation finished. |
Sources/NIO/EventLoop.swift
Outdated
| /// | ||
| /// - parameters: | ||
| /// - queue: The `DispatchQueue` to run `handler` on when the shutdown operation finished. | ||
| /// - handler: The handler which is called after the shutdown operation finished. The parameter will be `nil` |
Motivation: MultiThreadedEventLoopGroup's docs didn't make it clear that you leak threads if not shut down. Modifications: Add clarification that you should shut down MultiThreadedEventLoopGroups. Result: hopefully clearer documentation.
|
@Lukasa mind having a quick look again? |
Lukasa
approved these changes
Aug 21, 2018
weissi
added a commit
that referenced
this pull request
Aug 29, 2018
Motivation: MultiThreadedEventLoopGroup's docs didn't make it clear that you leak threads if not shut down. Modifications: Add clarification that you should shut down MultiThreadedEventLoopGroups. Result: hopefully clearer documentation. Motivation: Explain here the context, and why you're making that change. What is the problem you're trying to solve. Modifications: Describe the modifications you've done. Result: After your change, what will change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
MultiThreadedEventLoopGroup's docs didn't make it clear that you leak
threads if not shut down.
Modifications:
Add clarification that you should shut down
MultiThreadedEventLoopGroups.
Result:
hopefully clearer documentation.